It allows agents to turn off phones or sip devices to not receive any new calls. It also allows you to toggle between both sip and phone device.
https:/<sub_domain>/v2/integrations/device
<subdomain> with the region of your account
You can use our official postman collection to try out the APIs.
The following are the parameters:
|
Parameter |
Type |
Required |
Description |
|
Authorization |
String |
Yes |
Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token entity=app |
|
Parameter |
Type |
Required |
Description |
|
UserId |
String |
Required |
UserId |
|
DeviceName |
String |
Optional |
Device name required while turning on device. phone: turn on phone to receive call on phone. sip: receive call on web. |
|
DeviceStatus |
boolean |
Optional |
true, false |
curl --location --request PUT 'https://integrationscore.us3.qaexotel.com/v2/integrations/device' \ --header 'Authorization: {{AuthCode}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "UserId": "1", "DeviceName": "phone", "DeviceStatus": true }'
{ "RequestId": "ebf58ac4-fea1-4cd3-bf88-ffae7b8539a4", "Status": "Success", "Code": 200, "Error": "", "Data": { "CustomerId": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0", "AppID": "2e6440ed-ff62-49d7-bb00-5494b313a863", "AppUserId": "1", "ExotelAccountSid": "abc", "ExotelUserId": "fasdfdsf", "AppUsername": "Temp Name", "ExotelUserName": "Temp Name", "AgentNumber": "+0000000000", "ActiveDeviceId": "", "PhoneDeviceID": "057", "SipDeviceID": "9012", "VirtualNumber": "01135124165", "Email": "temp.user@company.in", "OutboundActive": false, "Role": "admin", "SipId": "sip:a4343j", "SipSecret": "b*5#TGC$2!r&s#X2H1Rt", "IsActive": true, "UserDetail": null, "CreatedAt": "0001-01-01T00:00:00Z", "UpdatedAt": "0001-01-01T00:00:00Z" } }
Status codes are as follows -
|
Status Code |
Description |
|
200 |
App users get successfully. |
|
401 |
Unauthorized. Check the entity id and secret. |
|
400 |
Invalid parameters. |
|
500 |
Internal server error. There was an issue getting users. |
1
