×

Create Authentication Token New

Creates an authentication token for the specified entity - customer or app. The token can be used to authenticate future requests to the integrations platform. The entity id and secret are required to create the token.

POST

https:/<sub_domain>/v2/integrations/token

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the POST parameters:

Parameter Name Mandatory/Optional Value
Id Mandatory ID of the entity - customer/app.
expire_in Optional

The duration(seconds) after which the short URL becomes invalid.
Minimum is 60 seconds and default is 31 days. max. value is  365 days

tracking Optional

Whether to track the short URL click. Can be: "true" or "false". "ShortenUrl" needs to be "true" for Tracking to work.

 

 

curl -X GET 
  https://:/v3/accounts//calls/ 
  -H 'content-type: application/json'
 
{
    "RequestId": "f4f76061-3c01-410e-be49-55a17049cf35",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": "OTlmYTk4YTEtMmNlMC00NTdjLTkzNzEtMGQzYTAxZWI2ZWYw"
}

Status Codes

The status codes are as follows - 

Status Code

Description

200

Token created successfully.

400

Bad request. Check the input parameters.

401

Unauthorized. Check the entity id and secret.

500

Internal server error. There was an issue creating the token.


Create new customer for Applications New

Creates a new customer in the integrations platform with the provided customer name and email.

POST

https:/<sub_domain>/v2/integrations/customer

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the POST parameters:

Parameter

Type

Required

Description

CustomerName

String

Yes

ID of the entity - customer/app.

Email

String

Yes

Secret of the entity - customer/app.

curl --location --request POST 'https://integrationscore.us3.qaexotel.com/v2/integrations/customer' \
--header 'Content-Type: application/json' \
--data-raw '{
   "CustomerName": "ABE",
   "Email": "xyz@exotel.in"
}'
{
    "RequestId": "05a9d895-d101-48d7-9a5c-46eda5a161c8",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": {
        "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
        "CustomerSecret": "5b8215f7-8595-42c0-9b63-404bcc474f94",
        "CustomerName": "John Doe",
        "Email": "johndoe@example.com",
        "CustomerSetting": null,
        "CreatedAt": "2023-03-23T09:36:25.967+05:30",
        "UpdatedAt": "2023-03-23T09:36:25.967+05:30",
        "DeletedAt": false
    }
}

Status Codes

Status codes are as follows -

Status Code

Description

200

Customer created successfully.

400

Bad request. Check the input parameters.

401

Unauthorized. Check the entity id and secret.

500

Internal server error. There was an issue creating the customer.

 

 

Get Customer detail for Applications

Retrieves details of the customer associated with the provided authorization token.

GET

https:/<sub_domain>/v2/integrations/customer

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the parameter details :

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token.

entity=customer

curl --location --request GET 'https://integrationscore.us3.qaexotel.com/v2/integrations/customer' \
--header 'Authorization: {{AuthCode}}'
{
    "RequestId": "01906552-dd91-4359-a184-739870991fa9",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": {
        "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
        "CustomerSecret": "5b8215f7-8595-42c0-9b63-404bcc474f94",
        "CustomerName": "Temp Name",
        "Email": "temp.mail@company.in",
        "CustomerSetting": null,
        "CreatedAt": "2023-03-23T09:36:26+05:30",
        "UpdatedAt": "2023-03-23T09:36:26+05:30",
        "DeletedAt": false
    }
}

Status Codes

Status code are as follows- 

Status Code

Description

200

Request successful. Customer details retrieved.

401

Unauthorized. Check the entity id and secret.

500

Internal server error. There was an issue getting the customer.

 

 

Delete Customer from system

Deletes the specified customer entity.

DELETE

https:/<sub_domain>/v2/integrations/customer

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the parameter details :

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=customer

 

curl --location --request DELETE 'https://integrationscore.us3.qaexotel.com/v2/integrations/customer' \
--header 'Authorization: {{AuthCode}}'
{
    "RequestId": "f940efa6-349e-45e1-a298-de24f9a6e1a5",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": "Deleted Successfully"
}

Status Codes

Status code are as follows- 

Status Code

Description

200

Customer deleted successfully.

401

Unauthorized. Check the entity id and secret.

500

Internal server error. There was an issue deleting the customer.


Register new application under customer New

The API endpoint allows registering a new application under a customer account.

POST

https:/<sub_domain>/v2/integrations/app

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the POST parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=customer

 

Body:

Parameter

Type

Required

Description

AppName

String

Yes

Application name

ExotelAccountSid

String

Yes

Account Id provided by exotel dashboard

ExotelApiKey

String

Yes

Api Key provided by exotel dashboard

ExotelApiToken

String

Yes

Api Token provided by exotel dashboard

ExotelDomain

String

Yes

Domain provided by exotel dashboard

IsActive

boolean

Yes

is application be ready for calling

 

curl --location --request POST 'https://integrationscore.us3.qaexotel.com/v2/integrations/app' \
--header 'Authorization: NmUxNGIyN2ItY2YzYy00MzRhLThlNzItYWNjMWFiNWQzY2Vi' \
--header 'Content-Type: application/json' \
--data-raw '{
   "AppName" : {{AppName}},
   "ExotelAccountSid": {{ExotelAccountSid}},
   "ExotelApiKey": {{ExotelApiKey}},
   "ExotelApiToken": {{ExotelApiToken}},
   "ExotelDomain": {{ExotelDomain}},
   "IsActive": true
}'
{
    "RequestId": "2405acfd-1ad3-486b-92d5-233965d8c204",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": {
        "AppID": "2e6440ed-ff62-49d7-bb00-5494b313a863",
        "AppSecret": "61b1f4c2-30d5-4819-9a5c-006ed9784313",
        "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
        "AppName": "WebRTC",
        "ExotelAccountSid": "abc",
        "ExotelApiKey": "wefwejfoiweuiof",
        "ExotelApiToken": "wefwejfoiweuiof",
        "ExotelDomain": "mumbai",
        "IsActive": true,
        "CreatedAt": "2023-03-23T11:47:46+05:30",
        "UpdatedAt": "2023-03-23T11:47:46+05:30"
    }
}

Status Codes

Status codes are as follows - 

 

Status Code

Description

200

Application created successfully.

400

Bad request. Check the input parameters.

401

Unauthorized. Check the entity id and secret.

500

Internal server error. There was an issue creating the application.

 

 

Get specific application detail

The GetAppByAppId API retrieves details of a specific application by its ID.

GET

https:/<sub_domain>/v2/integrations/app

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=app

 

Query Params:

Parameter

Type

Required

Value

entity

String

Yes

customer

 

curl --location --request GET 'https://integrationscore.us3.qaexotel.com/v2/integrations/app?entity=app' \
--header 'Authorization: {{AuthCode}}'
{
    "RequestId": "c0897a32-372e-4f82-ac18-eaa2d3451d52",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": {
        "AppID": "2e6440ed-ff62-49d7-bb00-5494b313a863",
        "AppSecret": "61b1f4c2-30d5-4819-9a5c-006ed9784313",
        "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
        "AppName": "WebRTC",
        "ExotelAccountSid": "abc",
        "ExotelApiKey": "wefwejfoiweuiof",
        "ExotelApiToken": "wefwejfoiweuiof",
        "ExotelDomain": "mumbai",
        "IsActive": true,
        "CreatedAt": "2023-03-23T11:47:46+05:30",
        "UpdatedAt": "2023-03-23T11:47:46+05:30"
    }
}

Status Codes

Status codes are as follows - 

Status Code

Description

200

Application get successfully.

400

Bad request. Check the input parameters.

401

Unauthorized. Check the entity id and secret.

500

Internal server error. There was an issue getting the application.

 

 

Get all application registered under same customer

This API endpoint retrieves a list of applications registered under a particular customer account.

GET

https:/<sub_domain>/v2/integrations/app

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=customer

 

Query Params:

Parameter

Type

Required

Value

entity

String

Yes

customer

 

curl --location --request GET 'https://integrationscore.us3.qaexotel.com/v2/integrations/app?entity=customer' \
--header 'Authorization: {{AuthCode}}'
{
    "RequestId": "1b13a16a-ad03-443e-83e7-0bb1b9297578",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": [
        {
          "AppID": "2e6440ed-ff62-49d7-bb00-5494b313a863",
          "AppSecret": "61b1f4c2-30d5-4819-9a5c-006ed9784313",
          "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
          "AppName": "WebRTC",
          "ExotelAccountSid": "abc",
          "ExotelApiKey": "wefwejfoiweuiof",
          "ExotelApiToken": "wefwejfoiweuiof",
          "ExotelDomain": "mumbai",
          "IsActive": true,
          "CreatedAt": "2023-03-23T11:47:46+05:30",
          "UpdatedAt": "2023-03-23T11:47:46+05:30"
        }
    ]
}

Status Codes

Status codes are as follows - 

Status Code

Description

200

Application get successfully.

400

Bad request. Check the input parameters.

401

Unauthorized. Check the entity id and secret.

500

Internal server error. There was an issue getting the application.

 

Delete App

Deletes the specified application entity.

DELETE

https:/<sub_domain>/v2/integrations/app

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=app

 

curl --location --request DELETE 'https://integrationscore.us3.qaexotel.com/v2/integrations/app' \
--header 'Authorization: {{AuthCode}}'
{
    "RequestId": "0e8beb2c-5682-4718-a4ba-b3b7aa2d3c72",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": "Deleted Successfully"
}

Status Codes

Status codes are as follows - 

Status Code

Description

200

App deleted successfully.

401

Unauthorized. Check the entity id and secret.

500

Internal server error. There was an issue deleting the App.

 


Add new Setting New

Add new setting configuration related to app.

POST

https:/<sub_domain>/v2/integrations/app_setting

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the POST parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=app

 

Body:

Field

Type

Required

Description

Key

String

Yes

config key.

Value

String

Yes

config value

 

curl --location --request POST 'https://integrationscore.us3.qaexotel.com/v2/integrations/app_setting' \
--header 'Authorization: {{AuthCode}}' \
--header 'Content-Type: application/json' \
--data-raw '{  
   "Key": {{configKey}},
   "Value" : {{configValue}}
}'
{
    "RequestId": "43a4833c-3698-4e70-8ea0-02ca8d71c362",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": {
        "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
        "AppID": "2e6440ed-ff62-49d7-bb00-5494b313a863",
        "Key": "callback",
        "Value": "https://webhook.site/a4089342-b169-451d-a84d-c588856641a3"
    }
}

Status Codes

Status codes are as follows - 

200

App Setting added successfully.

401

Unauthorized. Check the entity id and secret.

400

Invalid parameters.

500

Internal server error. There was an issue adding the App setting.

 

 

 

Get Setting with specific key

Get new setting configuration related to app.

GET

https:/<sub_domain>/v2/integrations/app_setting

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the POST parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=app

 

Query Params:

Parameter

Type

Required

Description

Key

String

Yes

config key.

 

curl --location -g --request GET 'https://integrationscore.us3.qaexotel.com/v2/integrations/app_setting?key={{configKey}}' \
--header 'Authorization: {{AuthCode}}'
{
    "RequestId": "43a4833c-3698-4e70-8ea0-02ca8d71c362",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": {
        "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
        "AppID": "2e6440ed-ff62-49d7-bb00-5494b313a863",
        "Key": "callback",
        "Value": "https://webhook.site/a4089342-b169-451d-a84d-c588856641a3"
    }
}

Status Codes

Status codes are as follows - 

200

App Setting added successfully.

401

Unauthorized. Check the entity id and secret.

400

Invalid parameters.

500

Internal server error. There was an issue adding the App setting.

 

 

 

Get all configuration for specific application

Get new setting configuration related to app.

GET

https:/<sub_domain>/v2/integrations/app_setting

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the POST parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=app

 

curl --location --request GET 'https://integrationscore.us3.qaexotel.com/v2/integrations/app_setting' \
--header 'Authorization: {{AuthCode}}'
{
    "RequestId": "43a4833c-3698-4e70-8ea0-02ca8d71c362",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": [
      {
          "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
          "AppID": "2e6440ed-ff62-49d7-bb00-5494b313a863",
          "Key": "callback",
          "Value": "https://webhook.site/a4089342-b169-451d-a84d-c588856641a3"
      }
    ]
}

Status Codes

Status codes are as follows - 

200

App Setting added successfully.

401

Unauthorized. Check the entity id and secret.

400

Invalid parameters.

500

Internal server error. There was an issue adding the App setting.

 

 

 

Delete setting

Delete app setting

DELETE

https:/<sub_domain>/v2/integrations/app_setting

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the POST parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=app

 

Body:

Parameter

Type

Required

Description

Key

String

Yes

config key.

 

curl --location -g --request DELETE 'https://integrationscore.us3.qaexotel.com/v2/integrations/app_setting?key={{configKey}}' \
--header 'Authorization: {{AuthCode}}'
{
    "RequestId": "c6539add-273a-4bed-8adf-c91a00a3e04b",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": "Deleted Successfully"
}

Status Codes

Status codes are as follows - 

Status Code

Description

200

App Setting Deleted successfully.

401

Unauthorized. Check the entity id and secret.

400

Invalid parameters.

500

Internal server error. There was an issue deleting the App setting.

 


Register users under specific application New

Add users under specific applications; users who can use the calling facility.

POST

https:/<sub_domain>/v2/integrations/usermapping

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the POST parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=app

 

Body:

List of users

Parameter

Type

Required

Description

AppUserId

string

Yes

ID of the application user

AppUsername

string

Yes

Name of the application user

'FirstName LastName', both length should be grater than 3.

Email

string

Yes

Email of the application user

ExotelAccountSid

string

Yes

Account Sid of the Exotel Account

ExotelUserName

string

Yes

Name of the application user

'FirstName LastName', both length should be grater than 3.

AgentNumber

string

Yes

Agent Number of the Exotel Account User

VirtualNumber

string

Yes

Virtual Number associated with the Exotel Account

 

curl --location --request POST 'https://integrationscore.us3.qaexotel.com/v2/integrations/usermapping' \
--header 'Authorization: {{AuthCode}}' \
--header 'Content-Type: application/json' \
--data-raw '[
   {
       "AppUserId": "123",
       "AppUsername": "ABC",
       "Email": "xyz@exotel.in",
       "ExotelAccountSid": {{ExotelAccountSid}},
       "ExotelUserName": "ABC XYZ",
       "AgentNumber": "956190****",
       "VirtualNumber": "0113512****"
   } 
{
    "RequestId": "5002f634-05d9-45b9-9faf-431f980a25d5",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": [
        {
            "CustomerId": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
            "AppID": "2e6440ed-ff62-49d7-bb00-5494b313a863",
            "AppUserId": "1",
            "ExotelAccountSid": "exoteldemo",
            "ExotelUserId": "fasdfdsf",
            "AppUsername": "user1 name",
            "ExotelUserName": "Temp Name",
            "AgentNumber": "9234567890",
            "ActiveDeviceId": "",
            "PhoneDeviceID": "057",
            "SipDeviceID": "9012",
            "VirtualNumber": "9876543210"
            "Email": "user@example.com",
            "OutboundActive": false,
            "Role": "admin",
            "SipId": "sip:a4343j",
            "SipSecret": "werewrweff",
            "IsActive": true,
            "UserDetail": null,
            "CreatedAt": "0001-01-01T00:00:00Z",
            "UpdatedAt": "0001-01-01T00:00:00Z"
        },
        {
            "CustomerId": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
            "AppID": "2e6440ed-ff62-49d7-bb00-5494b313a863",
            "AppUserId": "2",
            "ExotelAccountSid": "exoteldemo",
            "ExotelUserId": "fasdfdsf",
            "AppUsername": "user2 name",
            "ExotelUserName": "Temp Name",
            "AgentNumber": "9234567890",
            "ActiveDeviceId": "",
            "PhoneDeviceID": "057",
            "SipDeviceID": "9012",
            "VirtualNumber": "9876543210"
            "Email": "user@example.com",
            "OutboundActive": false,
            "Role": "admin",
            "SipId": "sip:a4343j",
            "SipSecret": "werewrweff",
            "IsActive": true,
            "UserDetail": null,
            "CreatedAt": "0001-01-01T00:00:00Z",
            "UpdatedAt": "0001-01-01T00:00:00Z"
        }
    ]
}

Status Codes

 

Status codes are as follows - 

Status Code

Description

200

App users added successfully.

401

Unauthorized. Check the entity id and secret.

400

Invalid parameters.

500

Internal server error. There was an issue adding users.

 

 

 

Get User details

Get specific user.

GET

https:/<sub_domain>/v2/integrations/usermapping

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=app

 

Query params:

Parameter

Type

Required

Description

user_id

String

Yes

User Id

 

curl --location -g --request GET 'https://integrationscore.us3.qaexotel.com/v2/integrations/usermapping?user_id={{userId}}' \
--header 'Authorization: {{AuthCode}}'
{
    "RequestId": "5002f634-05d9-45b9-9faf-431f980a25d5",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": {
            "CustomerId": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0",
            "AppID": "2e6440ed-ff62-49d7-bb00-5494b313a863",
            "AppUserId": "1",
            "ExotelAccountSid": "ACXXXXXXXXXXX",
            "ExotelUserId": "fasdfdsf",
            ""AppUsername": "example user",
            "ExotelUserName": "Temp Name",
            "AgentNumber": "1234567890",
            "ActiveDeviceId": "",
            "PhoneDeviceID": "057",
            "SipDeviceID": "9012",
            "VirtualNumber": "9876543210"
            "Email": "user@example.com",
            "OutboundActive": false,
            "Role": "admin",
            "SipId": "sip:a4343j",
            "SipSecret": "*****",
            "IsActive": true,
            "UserDetail": null,
            "CreatedAt": "0001-01-01T00:00:00Z",
            "UpdatedAt": "0001-01-01T00:00:00Z"
        }
}

Status Codes

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.

 

 

Delete users under applications

Delete all users under application

DELETE

https:/<sub_domain>/v2/integrations/usermapping

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=app

 

curl --location --request DELETE 'https://integrationscore.us3.qaexotel.com/v2/integrations/usermapping' \
--header 'Authorization: {{AuthCode}}'
{
    "RequestId": "5002f634-05d9-45b9-9faf-431f980a25d5",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": "Deleted Successfuly"
}

Status Codes

Status codes are as follows - 

Status Code

Description

200

App users deleted successfully.

401

Unauthorized. Check the entity id and secret.

400

Invalid parameters.

500

Internal server error. There was an issue deleting users.

 

 

Get users detail with pagination

Get specific users under application using pagination.

GET

https:/<sub_domain>/v2/integrations/usermapping

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=app

 

Query params:

Parameter

Type

Required

Description

last_value

integer

Optional

It required for next page value, gather from previous page.

Default value: 0

page_size

integer

Optional

Default size 20.

 

curl --location -g --request GET 'https://integrationscore.us3.qaexotel.com/v2/integrations/usermapping?last_value={{optional}}&page_size={{optional}}' \
--header 'Authorization: {{AuthCode}}'
{
    "RequestId": "875cf137-90f9-4ed2-93ef-6be226d0af85",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": {
        "Users": [
                {
            "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"
        },
        {
                ....
        },
               ....
        ],
        "PageSize": 20,
        "LastEvaluatedValue": "21"
    }
}

Status Codes

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.

 

 

Update device

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.

PUT

https:/<sub_domain>/v2/integrations/device

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

 

The following are the parameters:

Header:

Parameter

Type

Required

Description

Authorization

String

Yes

Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token

entity=app

 

Body:

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

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.

 


Receive inbound call notification New

It allows users to get a notification on their dashboard screen, whenever any Incoming call comes to their customer-facing Exotel number.

GET

https:/<sub_domain>/v2/integrations/call/inbound_call/{appId}

  • Replace <subdomain> with the region of your account
    1. <subdomain> of Singapore cluster is @api.exotel.com

You can use our official postman collection to try out the APIs.

curl --location -g --request GET 'https://integrationscore.us3.qaexotel.com/v2/integrations/call/inbound_call/{appId}'
{
    "RequestId": "5be38737-4a1c-4b29-9ede-b81ad2d702b6",
    "Status": "Success",
    "Code": 200,
    "Error": "",
    "Data": "Success"
}

 

 

 

Payload sent to App Setting API based upon call status:

{
  "CustomerId": "5f05a1ba-5564-4dfd-ac43-3e1f3e47c23d",
  "AppId": "977b0073-c11f-4bdd-ba8a-5c040a103d47",
  "CallSid": "500eac55f3d358ebaacb2b065ffc173r",
  "ExotelAccountSid": "exotel535",
  "DialWhomNumber": "07251937261",
  "VirtualNumber": "04448134021",
  "Direction": "incoming",
  "CallStatus": "busy", //CallStatus will be "free" once call is completed
  "CallState": "",
  "ToNumber": "04448134021",
  "FromNumber": "09938883886",
  "TotalDuration": "",
  "CallRecordings": "",
  "AccountDomain": "singapore",
  "TicketId": "",
  "CallDetail": null,
  "CreatedAt": "0001-01-01T00:00:00Z",
  "UpdatedAt": "0001-01-01T00:00:00Z"
}
{
  "CustomerId": "5f05a1ba-5564-4dfd-ac43-3e1f3e47c23d",
  "AppId": "977b0073-c11f-4bdd-ba8a-5c040a103d47",
  "CallSid": "500eac55f3d358ebaacb2b065ffc173r",
  "ExotelAccountSid": "exotel535",
  "DialWhomNumber": "07251937261",

 

  "VirtualNumber": "04448134021",
  "Direction": "incoming",
  "CallStatus": "",
  "CallState": "",
  "ToNumber": "04448134021",
  "FromNumber": "09938883886",
  "TotalDuration": "",
  "CallRecordings": "https://s3-ap-southeast-1.amazonaws.com/exotelrecordings/exotel535/500eac55f3d358ebaacb2b065ffc173r.mp3",
  "AccountDomain": "singapore",
  "TicketId": "",
  "CallDetail": null,
  "CreatedAt": "0001-01-01T00:00:00Z",
  "UpdatedAt": "0001-01-01T00:00:00Z"
}
{
  "CustomerId": "5f05a1ba-5564-4dfd-ac43-3e1f3e47c23d",
  "AppId": "977b0073-c11f-4bdd-ba8a-5c040a103d47",
  "CallSid": "0123a667c9d4e7fb82d7317e4aeb173r",
  "ExotelAccountSid": "exotel535",
  "DialWhomNumber": "07251937261",
  "VirtualNumber": "04448134021",
  "Direction": "incoming",
  "CallStatus": "",
  "CallState": "",
  "ToNumber": "04448134021",
  "FromNumber": "09938883886",
  "TotalDuration": "31",
  "CallRecordings": "",
  "AccountDomain": "singapore",
  "TicketId": "",
  "CallDetail": null,
  "CreatedAt": "0001-01-01T00:00:00Z",
  "UpdatedAt": "0001-01-01T00:00:00Z"
}

Status Codes

 

Status codes are as follows - 

Status Code

Description

200

Call Intimated successfully.

401

Unauthorized

400

Invalid parameters.

500

Internal server error. There was an issue getting call.