Registers a Session Initiation Protocol (SIP) device with a specified agent in an instance. A SIP device can be a physical SIP phone or a softphone.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. |
ccc-test |
| UserId |
string |
No |
The agent ID. |
agent@ccc-test |
| DeviceId |
string |
Yes |
The custom device ID. No specific format is required. |
test-device |
| Password |
string |
Yes |
The password used to authenticate the SIP device during registration. Keep this password secure. |
password |
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 |
| Params |
array |
||
|
string |
A response parameter. |
无 |
Examples
Success response
JSON format
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "无",
"RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
"Params": [
"无"
]
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Parameter.Blank | The parameter %s must not be blank. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.