Exotel API Docs

https://support.exotel.com/support/solutions/folders/92360
Admin
Exotel API Docs provide documentation and resources for integrating various Exotel communication...
Tokens:6,083
Snippets:26
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Getting a Popup when agent receives a call

Source: https://support.exotel.com/support/solutions/folders/92360/index

Configures the 'Connect' applet in a call flow to display a popup to an agent when they receive an incoming call.

```APIDOC
## POST /exotel/callflow/agent_popup

### Description
Sets up the 'Connect' applet within an Exotel call flow to trigger a visual popup on an agent's interface when they receive a call.

### Method
POST

### Endpoint
/exotel/callflow/agent_popup

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **call_flow_id** (string) - Required - The ID of the call flow to configure.
- **popup_url** (string) - Required - The URL to display in the agent's popup.
- **popup_title** (string) - Optional - The title for the popup window.

### Request Example
```json
{
  "call_flow_id": "cf_abcde",
  "popup_url": "https://agent-portal.com/call_info?callerId=%%callerid%%",
  "popup_title": "Incoming Call Details"
}
```

### Response
#### Success Response (200)
- **status** (string) - Status of the configuration update.
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "status": "success",
  "message": "Agent popup configured successfully."
}
```
```

--------------------------------

### Getting a Popup when agent receives a call

Source: https://support.exotel.com/support/solutions/folders/92360/page/1

Configure the 'Connect' applet in your call flow to display a popup to an agent when they receive an incoming call.

```APIDOC
## POST /call/flow/agent_popup

### Description
Configures the connect applet in a call flow to show a popup to an agent upon receiving a call.

### Method
POST

### Endpoint
/call/flow/agent_popup

### Parameters
#### Request Body
- **agent_id** (string) - Required - The identifier of the agent.
- **popup_url** (string) - Required - The URL to display in the popup.
- **call_id** (string) - Required - Identifier for the incoming call.
```

--------------------------------

### Call API to get details of a Call

Source: https://support.exotel.com/support/solutions/folders/92360/page/1

Retrieve detailed information about a specific call, including its status and cost, by making an HTTP GET request.

```APIDOC
## GET /calls/{call_id}

### Description
Retrieves detailed information about a specific call.

### Method
GET

### Endpoint
/calls/{call_id}

### Parameters
#### Path Parameters
- **call_id** (string) - Required - The unique identifier of the call.

#### Query Parameters
- **api_key** (string) - Required - Your Exotel API key.
- **api_token** (string) - Required - Your Exotel API token.
```

--------------------------------

### Call API to get details of a Call

Source: https://support.exotel.com/support/solutions/folders/92360/index

Retrieves details of a specific call, including its status and price, by making an HTTP GET request.

```APIDOC
## GET /exotel/calls/{call_id}

### Description
Fetches detailed information about a specific call, such as its status and cost.

### Method
GET

### Endpoint
/exotel/calls/{call_id}

### Parameters
#### Path Parameters
- **call_id** (string) - Required - The unique identifier of the call.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET "https://<your_api_key>:<your_api_token>@api.exotel.com/v1/Calls/<call_id>"
```

### Response
#### Success Response (200)
- **call_id** (string) - Unique identifier for the call.
- **status** (string) - The current status of the call.
- **price** (string) - The cost of the call.
- **start_time** (string) - The timestamp when the call started.
- **end_time** (string) - The timestamp when the call ended.

#### Response Example
```json
{
  "call_id": "123e4567-e89b-12d3-a456-426614174002",
  "status": "completed",
  "price": "$0.05",
  "start_time": "2023-03-02T10:00:00Z",
  "end_time": "2023-03-02T10:05:00Z"
}
```
```

--------------------------------

### Exotel API Key, Token, and Account SID

Source: https://support.exotel.com/support/solutions/folders/92360/page/2

Instructions on how to find your API Key, API Token, Account SID, and Subdomain for authenticating with Exotel APIs.

```APIDOC
## Obtaining API Credentials

### Description
To use Exotel APIs, you need to authenticate yourself using your API Key, API Token, and Account SID. These credentials can be found in your Exotel account settings.

### How to find credentials:
1. Log in to your Exotel Dashboard.
2. Navigate to the 'Account Settings' or 'API' section.
3. Your API Key, API Token, and Account SID (also referred to as Subdomain) will be displayed there.

### Example Usage in API Calls
When making API requests, you will typically include these credentials in the request headers or as part of the URL, depending on the specific API endpoint.

**Example Header Authentication:**
```
Authorization: Basic <base64_encoded_api_key:api_token>
X-API-Key: <your_api_key>
X-API-Token: <your_api_token>
```

**Example URL Parameter Authentication:**
```
https://<your_sid>.exotel.com/v1/some/endpoint?api_key=<your_api_key>&api_token=<your_api_token>
```
```

--------------------------------

### Campaigns API

Source: https://support.exotel.com/support/solutions/folders/92360/page/3

This API helps in setting up and managing call campaigns based on business objectives.

```APIDOC
## POST /campaigns

### Description
Create and manage call campaigns.

### Method
POST

### Endpoint
/campaigns

### Parameters
#### Request Body
- **objective** (string) - Required - The business objective of the campaign.
- **config** (object) - Required - Configuration details for the campaign, including guidelines and use cases.

### Request Example
```json
{
  "objective": "Lead generation",
  "config": {
    "guidelines": "...",
    "use_cases": "..."
  }
}
```

### Response
#### Success Response (200)
- **campaign_id** (string) - The ID of the created campaign.
- **status** (string) - The status of the campaign.

#### Response Example
```json
{
  "campaign_id": "camp_xyz789",
  "status": "active"
}
```
```

--------------------------------

### Outbound Call to connect a Customer to an App

Source: https://support.exotel.com/support/solutions/folders/92360/index

This API will first call the customer, and once they pick up the phone, it will connect them to an app (flow) created in Exotel.

```APIDOC
## POST /exotel/outbound_call_customer_to_app

### Description
Initiates an outbound call to a customer and connects them to a specified Exotel app (flow) upon pickup.

### Method
POST

### Endpoint
/exotel/outbound_call_customer_to_app

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **from_number** (string) - Required - The Exotel number initiating the call.
- **to_number** (string) - Required - The customer's number to call.
- **app_id** (string) - Required - The ID of the Exotel app/flow to connect to.

### Request Example
```json
{
  "from_number": "<your_exotel_number>",
  "to_number": "<customer_number>",
  "app_id": "<your_app_id>"
}
```

### Response
#### Success Response (200)
- **status** (string) - Call status.
- **call_id** (string) - Unique identifier for the call.

#### Response Example
```json
{
  "status": "queued",
  "call_id": "123e4567-e89b-12d3-a456-426614174001"
}
```
```

--------------------------------

### Outbound Call to connect a Customer to an App

Source: https://support.exotel.com/support/solutions/folders/92360/page/1

This API initiates an outbound call to a customer and, upon connection, routes them to a pre-configured Exotel app (flow).

```APIDOC
## POST /connect/customer/app

### Description
Initiates an outbound call to a customer and connects them to an Exotel app.

### Method
POST

### Endpoint
/connect/customer/app

### Parameters
#### Request Body
- **customer_number** (string) - Required - The customer's phone number.
- **app_id** (string) - Required - The ID of the Exotel app to connect to.
- **from** (string) - Optional - The caller ID number.
```

--------------------------------

### API to convert text to high quality voice using Shout Out app

Source: https://support.exotel.com/support/solutions/folders/92360/index

Converts text into high-quality voice and delivers it to cell phones via an API.

```APIDOC
## POST /exotel/shoutout/text_to_voice

### Description
Converts provided text into high-quality voice using the Shout Out app and delivers it to a specified phone number.

### Method
POST

### Endpoint
/exotel/shoutout/text_to_voice

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **phone_number** (string) - Required - The recipient's phone number.
- **text** (string) - Required - The text to be converted to voice.
- **language** (string) - Optional - The language for the voice output (e.g., 'en-US').
- **voice** (string) - Optional - The voice to be used (e.g., 'male', 'female').

### Request Example
```json
{
  "phone_number": "<recipient_phone_number>",
  "text": "Hello, this is a test message.",
  "language": "en-US",
  "voice": "female"
}
```

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **message_id** (string) - Unique identifier for the voice message.

#### Response Example
```json
{
  "status": "success",
  "message_id": "msg_abc123"
}
```
```

--------------------------------

### Working with Passthru Applet

Source: https://support.exotel.com/support/solutions/folders/92360/index

Allows Exotel to communicate with your Application URL during a call, passing call details in real-time.

```APIDOC
## POST /exotel/callflow/passthru

### Description
Configures the Passthru applet in a call flow to enable Exotel to send call-related data to a specified application URL.

### Method
POST

### Endpoint
/exotel/callflow/passthru

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **call_flow_id** (string) - Required - The ID of the call flow to modify.
- **passthru_url** (string) - Required - The URL of your application to receive call data.
- **method** (string) - Optional - The HTTP method to use for the request (e.g., 'POST', 'GET'). Defaults to 'POST'.

### Request Example
```json
{
  "call_flow_id": "cf_67890",
  "passthru_url": "https://your-app.com/exotel-callback",
  "method": "POST"
}
```

### Response
#### Success Response (200)
- **status** (string) - Status of the configuration.
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "status": "success",
  "message": "Passthru applet configured successfully."
}
```
```

--------------------------------

### Working with Passthru Applet

Source: https://support.exotel.com/support/solutions/folders/92360/page/1

Utilize the Passthru applet within your call flow to enable Exotel to communicate with your application URL, sending call details in real-time.

```APIDOC
## POST /call/flow/passthru

### Description
Configures the Passthru applet in a call flow to send call details to a specified application URL.

### Method
POST

### Endpoint
/call/flow/passthru

### Parameters
#### Request Body
- **call_id** (string) - Required - Identifier for the call.
- **application_url** (string) - Required - The URL of your application to receive call data.
- **event** (string) - Optional - The specific event to trigger the passthru (e.g., 'on_answer').
```

--------------------------------

### Connect API

Source: https://support.exotel.com/support/solutions/folders/92360/page/3

The Calls/connect API (POST) is used to connect two numbers or connect a number to a call flow.

```APIDOC
## POST /calls/connect

### Description
Connect two numbers or connect a number to a call flow.

### Method
POST

### Endpoint
/calls/connect

### Parameters
#### Request Body
- **from** (string) - Required - The 'From' number.
- **to** (string) - Required - The 'To' number or call flow identifier.
- **callback_url** (string) - Optional - URL to receive call status updates.

### Request Example
```json
{
  "from": "+11234567890",
  "to": "+10987654321",
  "callback_url": "http://example.com/callback"
}
```

### Response
#### Success Response (200)
- **call_id** (string) - The ID of the initiated call.
- **status** (string) - The status of the call (e.g., 'initiated', 'ringing').

#### Response Example
```json
{
  "call_id": "call_abc123",
  "status": "initiated"
}
```
```

--------------------------------

### Outbound Call to connect an Agent to a Customer

Source: https://support.exotel.com/support/solutions/folders/92360/index

This API will connect the two numbers given for an agent and the customer. It will connect the ‘From’ number first. Once the person at the...

```APIDOC
## POST /exotel/outbound_call_agent_customer

### Description
Connects an agent to a customer by initiating a call to the agent's number first.

### Method
POST

### Endpoint
/exotel/outbound_call_agent_customer

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **from_number** (string) - Required - The Exotel number initiating the call.
- **to_number** (string) - Required - The customer's number to connect to.
- **agent_number** (string) - Required - The agent's number to connect.

### Request Example
```json
{
  "from_number": "<your_exotel_number>",
  "to_number": "<customer_number>",
  "agent_number": "<agent_number>"
}
```

### Response
#### Success Response (200)
- **status** (string) - Call status.
- **call_id** (string) - Unique identifier for the call.

#### Response Example
```json
{
  "status": "queued",
  "call_id": "123e4567-e89b-12d3-a456-426614174000"
}
```
```

--------------------------------

### API to convert text to high quality voice using Shout Out app

Source: https://support.exotel.com/support/solutions/folders/92360/page/1

This API converts provided text into high-quality voice and delivers it to specified phone numbers.

```APIDOC
## POST /shoutout/text-to-voice

### Description
Converts text to high-quality voice and delivers it via phone calls.

### Method
POST

### Endpoint
/shoutout/text-to-voice

### Parameters
#### Request Body
- **phonenumber** (string) - Required - The recipient's phone number.
- **text** (string) - Required - The text to be converted to voice.
- **language** (string) - Optional - The language for the voice output (e.g., 'en').
```

--------------------------------

### How to send SMS using API?

Source: https://support.exotel.com/support/solutions/folders/92360/index

Sends an SMS message through the Exotel API by making an HTTP POST request.

```APIDOC
## POST /exotel/sms

### Description
Sends an SMS message to a specified recipient using the Exotel API.

### Method
POST

### Endpoint
/exotel/sms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **From** (string) - Required - Your Exotel number.
- **To** (string) - Required - The recipient's phone number.
- **Body** (string) - Required - The content of the SMS message.

### Request Example
```bash
curl -X POST "https://<your_api_key>:<your_api_token>@api.exotel.com/v1/Accounts/<account_sid>/Sms/send"
-d "From=<your_exotel_number>"
-d "To=<recipient_phone_number>"
-d "Body=This is a test SMS from Exotel."
```

### Response
#### Success Response (200)
- **SMSMessageSid** (string) - Unique identifier for the sent SMS.
- **Status** (string) - The status of the SMS delivery.

#### Response Example
```json
{
  "SMSMessageSid": "sms_uvw456",
  "Status": "queued"
}
```
```

--------------------------------

### Outbound Call to connect an Agent to a Customer

Source: https://support.exotel.com/support/solutions/folders/92360/page/1

This API connects a specified agent number to a customer number. The 'From' number (agent) is connected first.

```APIDOC
## POST /connect/agent/customer

### Description
Connects an agent to a customer via an outbound call.

### Method
POST

### Endpoint
/connect/agent/customer

### Parameters
#### Request Body
- **from** (string) - Required - The agent's phone number.
- **to** (string) - Required - The customer's phone number.
- **callback_url** (string) - Optional - URL to receive call status updates.
```

--------------------------------

### Send an SMS in response to an Incoming Call

Source: https://support.exotel.com/support/solutions/folders/92360/index

Configures a Call Flow to send a dynamic SMS reply to an incoming caller.

```APIDOC
## POST /exotel/callflow/incoming_sms_reply

### Description
Sets up a call flow to automatically send a predefined or dynamic SMS reply to a caller when an incoming call is received.

### Method
POST

### Endpoint
/exotel/callflow/incoming_sms_reply

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **incoming_number** (string) - Required - The Exotel number that receives the call.
- **reply_message** (string) - Required - The SMS message to send as a reply.
- **call_flow_id** (string) - Required - The ID of the call flow to configure.

### Request Example
```json
{
  "incoming_number": "<your_exotel_number>",
  "reply_message": "Thank you for calling. We will call you back shortly.",
  "call_flow_id": "cf_12345"
}
```

### Response
#### Success Response (200)
- **status** (string) - Status of the configuration update.
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "status": "success",
  "message": "SMS reply configured for incoming call."
}
```
```

--------------------------------

### Leg Details API

Source: https://support.exotel.com/support/solutions/folders/92360/page/3

This API allows you to query all participant details of completed calls.

```APIDOC
## GET /calls/{call_id}/legs

### Description
Retrieve details of all participants in a completed call.

### Method
GET

### Endpoint
/calls/{call_id}/legs

### Parameters
#### Path Parameters
- **call_id** (string) - Required - The ID of the call.

### Response
#### Success Response (200)
- **legs** (array) - A list of leg details for the call.
  - **participant_id** (string) - The ID of the participant.
  - **from** (string) - The 'From' number.
  - **to** (string) - The 'To' number.
  - **start_time** (string) - The start time of the leg.
  - **end_time** (string) - The end time of the leg.

#### Response Example
```json
{
  "legs": [
    {
      "participant_id": "leg_1",
      "from": "+11234567890",
      "to": "+10987654321",
      "start_time": "2023-10-27T10:00:00Z",
      "end_time": "2023-10-27T10:05:00Z"
    }
  ]
}
```
```

--------------------------------

### Send an SMS in response to an Incoming Call

Source: https://support.exotel.com/support/solutions/folders/92360/page/1

Configure your Call Flow to send a dynamic SMS reply to a caller when an incoming call is received.

```APIDOC
## POST /call/flow/sms_reply

### Description
Sets up a call flow to send a dynamic SMS reply to an incoming caller.

### Method
POST

### Endpoint
/call/flow/sms_reply

### Parameters
#### Request Body
- **call_id** (string) - Required - Identifier for the incoming call.
- **reply_text** (string) - Required - The text content for the SMS reply.
- **from_number** (string) - Required - The number to send the reply from.
- **to_number** (string) - Required - The number to send the reply to.
```

--------------------------------

### Bulk SMS API

Source: https://support.exotel.com/support/solutions/folders/92360/page/3

This API allows you to send bulk SMS messages. The process is the same as sending a single SMS.

```APIDOC
## POST /sms/bulk

### Description
Send bulk SMS messages to multiple recipients.

### Method
POST

### Endpoint
/sms/bulk

### Parameters
#### Request Body
- **to** (string) - Required - Comma-separated list of recipient phone numbers.
- **from** (string) - Required - Your Exotel shortcode or sender ID.
- **body** (string) - Required - The message content.

### Request Example
```json
{
  "to": "+1234567890,+1987654321",
  "from": "EXOTEL",
  "body": "This is a bulk SMS message."
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the sent message.
- **status** (string) - The status of the message (e.g., 'queued', 'sent').

#### Response Example
```json
{
  "message_id": "msg_12345abcde",
  "status": "queued"
}
```
```

--------------------------------

### How to send SMS using API?

Source: https://support.exotel.com/support/solutions/folders/92360/page/1

Send an SMS message through the Exotel API by making an HTTP POST request to the specified endpoint.

```APIDOC
## POST /sms/send

### Description
Sends an SMS message using the Exotel API.

### Method
POST

### Endpoint
/sms/send

### Parameters
#### Request Body
- **from** (string) - Required - The sender ID or Exotel number.
- **to** (string) - Required - The recipient's phone number.
- **body** (string) - Required - The content of the SMS message.
- **api_key** (string) - Required - Your Exotel API key.
- **api_token** (string) - Required - Your Exotel API token.
```

--------------------------------

### Send a SMS Reply in response to an Incoming SMS

Source: https://support.exotel.com/support/solutions/folders/92360/index

Currently, this functionality is not available. Only Outgoing SMS services are supported.

--------------------------------

### How to send an automated SMS after an outbound call using API?

Source: https://support.exotel.com/support/solutions/folders/92360/index

Enables sending an automated SMS message following an outbound call by passing additional parameters in the API request.

```APIDOC
## POST /exotel/outbound_call_with_sms

### Description
Initiates an outbound call and, upon completion, sends an automated SMS to the recipient.

### Method
POST

### Endpoint
/exotel/outbound_call_with_sms

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **from_number** (string) - Required - The Exotel number initiating the call and sending the SMS.
- **to_number** (string) - Required - The recipient's phone number.
- **call_details** (object) - Optional - Parameters related to the outbound call.
  - **url** (string) - URL to fetch call instructions.
- **sms_details** (object) - Required - Parameters for the SMS.
  - **message** (string) - Required - The content of the SMS message.
  - **message_url** (string) - Optional - URL to fetch SMS content.

### Request Example
```json
{
  "from_number": "<your_exotel_number>",
  "to_number": "<recipient_phone_number>",
  "sms_details": {
    "message": "Thank you for your call."
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Status of the operation.
- **call_id** (string) - Unique identifier for the outbound call.
- **sms_id** (string) - Unique identifier for the SMS message.

#### Response Example
```json
{
  "status": "success",
  "call_id": "123e4567-e89b-12d3-a456-426614174003",
  "sms_id": "sms_xyz789"
}
```
```

--------------------------------

### Metadata of a phone number API

Source: https://support.exotel.com/support/solutions/folders/92360/page/2

The number metadata API provides metadata for a given phone number, including its telecom circle and type.

```APIDOC
## GET /v1/accounts/{AccountSid}/Numbers/{Number}/metadata

### Description
Retrieves metadata for a specific phone number.

### Method
GET

### Endpoint
`/v1/accounts/{AccountSid}/Numbers/{Number}/metadata`

### Parameters
#### Path Parameters
- **AccountSid** (string) - Required - Your Exotel Account SID.
- **Number** (string) - Required - The phone number for which to retrieve metadata.

### Request Example
```json
{
  "message": "Requesting metadata for a phone number."
}
```

### Response
#### Success Response (200)
- **circle_name** (string) - The human-readable name of the telecom circle.
- **number_type** (string) - The type of the phone number (e.g., MOBILE, LANDLINE).

#### Response Example
```json
{
  "circle_name": "Karnataka",
  "number_type": "MOBILE"
}
```
```

--------------------------------

### How to send an automated SMS after an outbound call using API?

Source: https://support.exotel.com/support/solutions/folders/92360/page/1

This functionality allows sending an automated SMS message immediately following the completion of an outbound call. It requires passing additional parameters during the outbound API call.

```APIDOC
## POST /outbound/call/with_sms

### Description
Initiates an outbound call and schedules an SMS to be sent upon its completion.

### Method
POST

### Endpoint
/outbound/call/with_sms

### Parameters
#### Request Body
- **from** (string) - Required - The number from which the call will be made.
- **to** (string) - Required - The number to which the call will be made.
- **sms_text** (string) - Required - The content of the SMS message.
- **sms_to** (string) - Required - The number to which the SMS will be sent.
```

--------------------------------

### SMS Message Status API

Source: https://support.exotel.com/support/solutions/folders/92360/page/2

Provides status codes for SMS messages sent via Exotel.

```APIDOC
## GET /v1/Accounts/{AccountSid}/SMS/Messages/{MessageSid}/Status

### Description
Retrieves the delivery status of a specific SMS message.

### Method
GET

### Endpoint
`/v1/Accounts/{AccountSid}/SMS/Messages/{MessageSid}/Status`

### Parameters
#### Path Parameters
- **AccountSid** (string) - Required - Your Exotel Account SID.
- **MessageSid** (string) - Required - The unique identifier for the SMS message.

### Request Example
```json
{
  "message": "Requesting status for an SMS message."
}
```

### Response
#### Success Response (200)
- **status** (string) - The current delivery status of the SMS (e.g., `queued`, `sent`, `delivered`, `failed`).

#### Response Example
```json
{
  "status": "delivered"
}
```
```
Tokens:
Raw