Add new setting configuration related to app.
https://integrationscore.mum1.exotel.com/v2/integrations/app_setting
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=app |
|
Field |
Type |
Required |
Description |
|
Key |
String |
Yes |
config key |
|
Value |
String |
Yes |
config value |
| Key Name | Description |
| popup | Use this key whenever you'd like your application to display pop-up notifications for incoming calls. |
|
incomingCallHangup |
Use this key whenever you'd like your application to know that the call ended successfully |
|
missedCall |
Use this key whenever you'd like your application to receive missed call notification |
| callback | Use this key whenever you'd like your application to receive statuscallback for an outbound call |
| record |
Set this value to "true" if you'd like to record the outbound calls. Default value is false. Note - To record inbound calls, you can check the "record call" option in the connect applet of the inbound flow. |
| streaming |
url that supports webSocket where audio will be streamed. Example - "wss://streamhandler.yourdomain.com" If this value is not set, calls through this application will not be streamed. |
| playback |
URL for the audio to be played just before the call gets connected. If this value is not set, the operator tune will be played to the agent. |
A sample Key and Value is defined in the below Example request.
curl --location --request POST 'https://integrationscore.mum1.exotel.com/v2/integrations/app_setting' \ --header 'Authorization: {{AuthCode}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "Key": "popup", "Value" : "https://webhook.site/" }'
{ "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 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 new setting configuration related to app.
https://integrationscore.mum1.exotel.com/v2/integrations/app_setting
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=app |
|
Parameter |
Type |
Required |
Description |
|
Key |
String |
Yes |
config key. |
curl --location -g --request GET 'https://integrationscore.mum1.exotel.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 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 new setting configuration related to app.
https://integrationscore.mum1.exotel.com/v2/integrations/app_setting
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=app |
curl --location --request GET 'https://integrationscore.mum1.exotel.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 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 app setting
https://integrationscore.mum1.exotel.com/v2/integrations/app_setting
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.mum1.exotel.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 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. |
1
