×

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

 

  • Request Example
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}}
}'
  • Response Example
{
    "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.

 

  • Request Example
curl --location -g --request GET 'https://integrationscore.us3.qaexotel.com/v2/integrations/app_setting?key={{configKey}}' \
--header 'Authorization: {{AuthCode}}'
  • Response Example
{
    "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

 

  • Request Example
curl --location --request GET 'https://integrationscore.us3.qaexotel.com/v2/integrations/app_setting' \
--header 'Authorization: {{AuthCode}}'
  • Response Example
{
    "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.

 

  • Request Example
curl --location -g --request DELETE 'https://integrationscore.us3.qaexotel.com/v2/integrations/app_setting?key={{configKey}}' \
--header 'Authorization: {{AuthCode}}'
  • Response Example
{
    "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.