Client Configurations resource

On this reference page, you'll learn about the parameters and properties for the Client Configurations resource, which stores Twilio Voice client configuration data such as webhook URLs. See Related how-to documentation to learn the steps to use the info on this page.

(new)

Private Beta

The Client Configurations resource is currently available as a Private Beta product, and Twilio may change the information in this document at any time. This means that some features aren't yet implemented, and others may change before the product becomes Generally Available. Private Beta products aren't covered by a Service Level Agreement.

(information)

Info

Read more about the Call Notification feature on the Call Notification via Webhook page.

Create a Client Configuration

1  curl -X POST https://voice.twilio.com/v2/Configurations/Client \
2  -H "Content-Type: application/json" \
3  -d '{"unique_name": "my_webhook", "description": "my webhook", "configuration": {"configurationType":"Client", "callnotification": {"url":"https://myurl.com", "method": "POST"}}}' \
4  -u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

1{
2    "account_sid": "ACxxxxxxxxxxxxxxxxxxxxx",
3    "configuration": {
4        "configurationType": "Client",
5        "callnotification": {
6            "method": "POST",
7            "url": "https://myurl.com"
8        }
9    },
10    "description": "my webhook",
11    "unique_name": "my_webhook",
12    "id": "voice_clientconfiguration_xxxxxxxxx"
13}

(information)

Info

unique_name cannot contain spaces.

Retrieve a Client Configuration

1curl -X GET  https://voice.twilio.com/v2/Configurations/Client/voice_clientconfiguration_xxxxxxx \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

1{
2    "account_sid": "ACxxxxxxxxxxxxxxxxxxxxx",
3    "configuration": {
4        "configurationType": "Client",
5        "callnotification": {
6            "method": "POST",
7            "url": "https://myurl.com"
8        }
9    },
10    "description": "my webhook",
11    "unique_name": "my_webhook",
12    "id": "voice_clientconfiguration_xxxxxxxxx"
13}

Retrieve a list of Client Configurations

1curl -X GET  "https://voice.twilio.com/v2/Configurations/Client?pageSize=1&pageToken=xxxxxxxxx" \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

1{
2    "content": [
3        {
4            "account_sid": "ACxxxxxxxxxx",
5            "configuration": {
6                "configurationType": "Client",
7                "callnotification": {
8                    "method": "POST",
9                    "url": "https://myurl.com"
10                }
11            },
12            "description": "my webhook",
13            "unique_name": "my_webhook",
14            "id": "voice_clientconfiguration_xxxxxxxx"
15        }
16    ],
17    "meta": {
18        "direct_token": true,
19        "list_key": "content",
20        "next_token": "xxxxxxx",
21        "page_size": 1,
22        "previous_token": "xxxxxxxxxxxxxx"
23    }
24}

(information)

Info

pageSize and pageToken are optional parameters.

Update a Client Configuration

1curl -X PUT https://voice.twilio.com/v2/Configurations/Client/voice_clientconfiguration_xxxxx \
2-H "Content-Type: application/json" \
3-d '{"unique_name": "my_updated_webhook", "configuration": {"configurationType": "Client", "callnotification": {"url":"https://my_updated_url", "method": "POST"}}}' \
4-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

1{
2    "account_sid": "ACxxxxxxxxxxxxxxxxxxxxx",
3    "configuration": {
4        "configurationType": "Client",
5        "callnotification": {
6            "method": "POST",
7            "url": "https://my_updated_url.com"
8        }
9    },
10    "description": null,
11    "unique_name": "my_updated_webhook",
12    "id": "voice_clientconfiguration_xxxxxxxxx"
13}

(information)

Info

If we omit or leave a parameter value as null in the update request then the value will be updated to null or the request will result in an error.

Delete a Client Configuration

1curl -X DELETE https://voice.twilio.com/v2/Configurations/Client/voice_clientconfiguration_xxxxxx \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

<No Content>

Set a Client Configuration as the default account configuration

1curl -X POST  https://voice.twilio.com/v2/Configurations/Client/Default \
2-H "Content-Type: application/json" \
3-d '{"configuration_id": "voice_clientconfiguration_xxxxxx"}' \
4-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

<No Content>

Retrieve the default Client Configuration for the account

1curl -X GET  https://voice.twilio.com/v2/Configurations/Client/Default \
2$TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

1{
2    "account_sid": "ACxxxxxxxxxxxxxxxxxxxxx",
3    "configuration": {
4        "configurationType": "Client",
5        "callnotification": {
6            "method": "POST",
7            "url": "https://myurl.com"
8        }
9    },
10    "description": "my webhook",
11    "unique_name": "my_webhook",
12    "id": "voice_clientconfiguration_xxxxxxxxx"
13}

Unset the default Client Configuration

1curl -X DELETE  https://voice.twilio.com/v2/Configurations/Client/Default \
2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

<No Content>