×

Using this API, you will be able to reset your user's SIP password. A new password should be provided in the request. A pre-requisite for creating the SIP password is that the SIP id of the user should be created in Exotel. SIP Id is auto-generated at the time of user creation either via Create User API or during manual addition of a co-worker in the Exotel dashboard. After a successful validation of the SIP Id, the SIP password provided will be set for the user. The SIP password must contain:

1) At least 8 characters and 

2) At least 3 of the following:

a) Lower case letters (a-z)

b) Upper case letters (A-Z)

c) Numbers (0-9)

d) Special characters (ex. !@#$%^&*)

 

To create or update a SIP password for your user, you will need to make an HTTP PUT request to

PUT

https://<your_api_key><your_api_token><subdomain>/v2/accounts/<your_sid>/users/<uuid>/devices/<device_id>/password

Example (For Singapore Stamp)-

PUT

https://<your_api_key><your_api_token>@ccm-api.exotel.com/v2/accounts/<your_sid>/users/<uuid>/devices/<device_id>/password

Example (For Mumbai Stamp)

PUT

https://<your_api_key><your_api_token>@ccm-api.in.exotel.com/v2/accounts/<your_sid>/users/<uuid>/devices/<device_id>/password

  • Replace <your_api_key> and <your_api_token> with the API key and token created by you OR use Basic Authentication.
  • Replace <your_sid> with your “Account sid”
  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @ccm-api.exotel.com
    2. <subdomain> of Mumbai cluster is @ccm-api.in.exotel.com

<your_api_key> , <your_api_token> and <your_sid> are available in the API settings page of your Exotel Dashboard

 

Request Parameter Description:-

Parameter

Mandatory/Optional

Value/Description

password

Mandatory

String; New password string adhering to the password policy mentioned above

 

HTTP Response:

  • On success, the HTTP response status code will be 200

 

Response Parameter Description:-

Parameter Name

Type & Value

request_id

This indicates the unique id of the request. Useful for debugging and tracing purposes.

method

This indicates the HTTP method for the request such as GET/POST/PUT etc.

http_code

This indicates the HTTP code for the request such as 200, 400, 500 etc.

response

Response block contains the user device record matching the request URI. The block contains

  • code - This indicates the http code for the particular record in the response array like 200, 400 etc.
  • error_data - This block will be null if there is no error else contain error information for the response with following fields
    • code - This would be the error code useful for Exotel's team to debug and can be highlighted in case of unexpected errors.
    • description - This describes the details of the error.
    • message - This is the error message corresponding to the error code useful for Exotel's team to debug and can be highlighted in case of unexpected errors.
  • status - This field would indicate status of the response (success/failure).

 

 

  • Example Response
{
  "request_id": "affd93c2e3674424993e4d70c012156e",
  "method": "PUT",
  "http_code": 200,
  "response": {
    "code": 200,
    "error_data": null,
    "status": "success",
    "data": null
  }
}