Call GetTurnCredentials to get the connection credentials for a Cloud Contact Center Point of Presence (PoP). These credentials include a username and password for authentication. Connecting to Cloud Contact Center through a PoP improves network quality and stability.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The ID of the instance. |
ccc-test |
| UserId |
string |
No |
The ID of the agent. This parameter is optional. If you do not specify this parameter, the agent mapped to the current RAM user is used by default. |
agent@ccc-test |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Code |
string |
The response code. |
OK |
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| Message |
string |
The response message. |
无 |
| RequestId |
string |
The request ID. |
EEEE671A-3E24-4A04-81E6-6C4F5B39DF75 |
| Data |
object |
The data returned. |
|
| UserName |
string |
The username. |
1602585817:**** |
| Password |
string |
The password. |
M0NQNG/uRUrfIxW7er/S9gKX**** |
| Params |
array |
||
|
string |
The response parameters. |
无 |
Examples
Success response
JSON format
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "无",
"RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
"Data": {
"UserName": "1602585817:****",
"Password": "M0NQNG/uRUrfIxW7er/S9gKX****"
},
"Params": [
"无"
]
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Parameter.Blank | The parameter %s may not be null or blank. | |
| 400 | Parameter.Null | The parameter %s may not be null. | |
| 500 | InternalService.Common | An internal service error occurred. %s | |
| 404 | NotExists.InstanceId | The specified instance %s does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.