GetTurnCredentials - 获取接入点凭证

调用GetTurnCredentials获取云呼叫中心前置接入点的连接凭证信息,主要包括鉴权需要用到的用户名和密码,通过前置接入点接入云呼叫中心可以有效提高网络质量和稳定性。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

ccc-test
UserIdstring

坐席 ID,非必填,不填则默认使用当前 RAM 账户映射的坐席。

agent@ccc-test

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Dataobject

数据。

UserNamestring

用户名。

1602585817:****
Passwordstring

密码。

M0NQNG/uRUrfIxW7er/S9gKX****
Paramsarray
Paramstring

响应参数。

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Data": {
    "UserName": "1602585817:****",
    "Password": "M0NQNG/uRUrfIxW7er/S9gKX****"
  },
  "Params": [
    "无"
  ]
}

错误码

HTTP status code错误码错误信息描述
400Parameter.BlankThe parameter %s may not be null or blank.该参数不能为null或含有空白符的字符串。
400Parameter.NullThe parameter %s may not be null.该参数不能为null值.
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
500InternalService.CommonAn internal service error occurred. %s内部服务错误。

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

变更历史

变更时间变更内容概要操作
2023-11-06OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情