The API endpoint allows registering a new application under a customer account.
https://integrationscore.mum1.exotel.com/v2/integrations/app
You can use our official postman collection to try out the APIs.
The following are the POST parameters:
|
Parameter |
Type |
Required |
Description |
|
Authorization |
String |
Yes |
Token provided by https://integrationscore.mum1.exotel.com/v2/integrations/token entity=customer |
|
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. (Singapore/Mumbai) |
|
IsActive |
boolean |
Yes |
Is application be ready for calling |
curl --location --request POST 'https://integrationscore.mum1.exotel.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 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. |
This API allows you to get app details by AppId.
https://integrationscore.mum1.exotel.com/v2/integrations/app
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 |
app |
curl --location --request GET 'https://integrationscore.mum1.exotel.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", "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0", "AppName": "WebRTC", "ExotelAccountSid": "abc", "ExotelDomain": "mumbai", "IsActive": true, "CreatedAt": "2023-03-23T11:47:46+05:30", "UpdatedAt": "2023-03-23T11:47:46+05:30" } }
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. |
This API endpoint retrieves a list of applications registered under a customer account.
https://integrationscore.mum1.exotel.com/v2/integrations/app
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.mum1.exotel.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", "CustomerID": "99fa98a1-2ce0-457c-9371-0d3a01eb6ef0", "AppName": "WebRTC", "ExotelAccountSid": "abc", "ExotelDomain": "mumbai", "IsActive": true, "CreatedAt": "2023-03-23T11:47:46+05:30", "UpdatedAt": "2023-03-23T11:47:46+05:30" } ] }
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. |
Deletes the specified application entity.
https://integrationscore.mum1.exotel.com/v2/integrations/app
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.mum1.exotel.com/v2/integrations/app' \ --header 'Authorization: {{AuthCode}}'
{ "RequestId": "0e8beb2c-5682-4718-a4ba-b3b7aa2d3c72", "Status": "Success", "Code": 200, "Error": "", "Data": "Deleted Successfully" }
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. |
