调用ListRoles获取角色列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListRoles

系统规定参数。取值:ListRoles。

JsonStr String ""

jsonStr的值直接传空字符串即可。

返回数据

名称 类型 示例值 描述
Code String 200

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

Data Array

详细返回数据。

Role
CreateTime String 2019-06-20T17:33Z

创建时间。

DisplayName String 坐席

角色显示名称。

Id Long 3

角色ID。

Level Integer 99

弃用字段,请忽略。

Name String AGENT

角色名称,可能值:ADMIN(管理员);QUALITY_INSPECTOR(质检员);AGENT(客服)。

UpdateTime String 2019-06-20T17:33Z

最后更新时间。

Message String successful

出错时表示出错详情,成功时为successful。

RequestId String 106C6CA0-282D-4AF7-85F0-D2D24F4CE647

请求ID。

Success Boolean true

请求是否成功,调用方可根据此字段来判断请求是否成功:true表示成功;false/null表示失败。

示例

请求示例

http(s)://[Endpoint]/?Action=ListRoles
&<公共请求参数>

正常返回示例

XML 格式

<ListRolesResponse>
      <Message>successful</Message>
      <RequestId>DA0B5815-F180-42B0-BE4B-FFF019BA18FF</RequestId>
      <Data>
            <Role>
                  <CreateTime>2019-06-20T17:33Z</CreateTime>
                  <DisplayName>管理员</DisplayName>
                  <UpdateTime>2019-06-20T17:33Z</UpdateTime>
                  <Level>99</Level>
                  <Id>2</Id>
                  <Name>ADMIN</Name>
            </Role>
            <Role>
                  <CreateTime>2019-06-20T17:33Z</CreateTime>
                  <DisplayName>质检员</DisplayName>
                  <UpdateTime>2019-06-20T17:33Z</UpdateTime>
                  <Level>50</Level>
                  <Id>3</Id>
                  <Name>QUALITY_INSPECTOR</Name>
            </Role>
            <Role>
                  <CreateTime>2019-06-20T17:33Z</CreateTime>
                  <DisplayName>坐席</DisplayName>
                  <UpdateTime>2019-06-20T17:33Z</UpdateTime>
                  <Level>20</Level>
                  <Id>4</Id>
                  <Name>AGENT</Name>
            </Role>
      </Data>
      <Code>200</Code>
      <Success>true</Success>
</ListRolesResponse>

JSON 格式

{
    "Message":"successful",
    "RequestId":"DA0B5815-F180-42B0-BE4B-FFF019BA18FF",
    "Data":{
        "Role":[
            {
                "CreateTime":"2019-06-20T17:33Z",
                "DisplayName":"管理员",
                "UpdateTime":"2019-06-20T17:33Z",
                "Level":99,
                "Id":2,
                "Name":"ADMIN"
            },
            {
                "CreateTime":"2019-06-20T17:33Z",
                "DisplayName":"质检员",
                "UpdateTime":"2019-06-20T17:33Z",
                "Level":50,
                "Id":3,
                "Name":"QUALITY_INSPECTOR"
            },
            {
                "CreateTime":"2019-06-20T17:33Z",
                "DisplayName":"坐席",
                "UpdateTime":"2019-06-20T17:33Z",
                "Level":20,
                "Id":4,
                "Name":"AGENT"
            }
        ]
    },
    "Code":"200",
    "Success":true
}

错误码

访问错误中心查看更多错误码。