Introduction
The CarrierX service offers a hosted FlexML Application Endpoint type that enables creating voice work-flows by passing XML instructions. Using a variety of verbs, the endpoint interprets instructions and uses them to play recordings, route calls via DTMF inputs, and implement call flow logic.
Refer to the FlexML products page for quick start guides and video tutorials. These hold walk-through instructions on configuring FlexML endpoints, building simple voice applications, configuring inbound calls, and making outbound calls.
Using the REST API
This section describes how to obtain credentials to use the API, what types of requests the system recognizes, and the format of the responses. It also holds reference information about pagination, filtering, and callbacks.
Using Postman
This documentation contains cURL commands that you will run in your terminal. Rather than use these commands, you can explore the API using Postman, a stand-alone client with a user-friendly interface. Postman is widely used for API development and allows you to test requests.
You will need to download the Postman client to your computer. To do so, visit the Postman website and click Download. Click Run in Postman to import this collection to the Postman app.
For more information, see our Getting Started with Postman Quick Start Guide.
Main Conventions
The following conventions are used in the sections, which contain the tables with objects attributes, their types, and descriptions:
create | The attribute can be set when the user creates the object using the POST method. |
update | The attribute can be modified when the user updates the object using either PATCH or PUT methods. |
read only | The attribute is set by the system and the user can neither set nor modify it. |
Credentials
The following curl command will return a list of all of the endpoints of the CarrierX account associated with the login credentials. Use your Core API token in the query below. The endpoint
login
andpassword
values are listed in the returned JSON object.
curl -X GET \
'https://api.carrierx.com/core/v2/endpoints' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
The credentials of a specific endpoint are found in the properties attribute of the nested object. Locate the
login
andpassword
values.
{
"count": 2,
"has_more": false,
"items": [
{
"addresses": [
{
"direction": "any",
"ip": "10.1.10.69",
"port": 5060,
"transport": "udp"
}
],
"attributes": {},
"capacity": 0,
"endpoint_sid": "7fc3e7ea-a0df-4de1-836f-50318ed66466",
"name": "System Gateway",
"partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
"properties": {},
"transformations": [],
"type": "system_gateway",
"voip_token": null
},
{
"addresses": [],
"attributes": {},
"capacity": 0,
"endpoint_sid": "844346ef-93e9-4fa8-a4ab-e3015af94573",
"name": "flex",
"partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
"properties": {
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"api_url": "https://api.carrierx.com/flexml/v1",
"container_sid": "null",
"login": "sample_login",
"password": "sample_password"
},
"transformations": [],
"type": "flexml",
"voip_token": null
}
],
"limit": 1000,
"offset": 0,
"pagination": {},
"total": 2
}
API requests require authentication. To obtain a CarrierX account and gain credentials, please submit a request through our Contact Us page. The Core API uses a bearer token, and the endpoint APIs (Conference, FlexML, and Mediator) use a login and password.
Prior to making requests, a FlexML Application Endpoint needs to be created. See the FlexML Endpoint quick start guide for step-by-step instructions on creating a FlexML endpoint.
Each of the application endpoints has different login
and password
values. Entering the Core API token credentials instead of the endpoint-specific credentials when working with the Conference, FlexML, or Mediator APIs will return the unauthorized
error.
Requests
Sample request to create Conference endpoint.
curl -X POST \
'https://api.carrierx.com/core/v2/endpoints' \
-H 'Content-Type: application/json' \
--data-binary '{"name":"my_conf", "type":"conference"}' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
The requests in CarrierX API are made using the standard REST notation, typical for web services. This includes the URL, to which the request will be sent, the request method, the request related headers, and, optionally, a payload.
Request URL
The usual path to the API objects include the base URL to the API used with the object (Core API base URL for the objects used throughout the CarrierX products, or specific API base URLs used for FlexML, Mediator, or Conference), and the path to the object collections and the object items.
If the action targets the specific object, the path to it will include the object secure ID (SID), which allows to distinguish the targeted object from the other ones in the same collection.
The system only accepts HTTPS requests, and not HTTP requests.
Request Methods
CarrierX API uses five main verbs (methods) of REST over HTTP for the requests: POST
, GET
, PUT
, PATCH
, and DELETE
. These methods are used to create the objects, get the information about the objects, modify the objects, and delete them.
CarrierX partners need to have special permissions (or scopes) to use API methods on various objects. Refer to the available_scopes table for the complete list of the scopes that define the partner’s permissions on objects and collections.
POST
The POST
method is used to create new objects. When you create a new object, you usually need to specify at least some of the attributes for the object to be created in the request payload.
The successful POST
request will return a 200
response with the serialized JSON copy of the created object.
GET
The GET
method is used to view the information about the existing objects and their collections.
Generic GET
requests return the list of all the objects (or collections) available for the request sent. Most of such GET
requests can be used together with Pagination, Result Filtering, and Field Filtering.
GET
requests aimed at a specific object require to use the object secure ID to be included as a part of the request path, and return the information about the specified object only. Most of such GET
requests can be used together with Field Filtering.
The successful GET
request will return a 200
response with the serialized JSON copy of the requested objects (or specific object).
PATCH/PUT
The PATCH
/PUT
methods are both used to modify the existing objects and their attributes. The difference between them is explained below.
Sample
PATCH
request to modify or add a newname
record of the nestedattributes
object.
curl -X PATCH \
'https://api.carrierx.com/core/v2/partners/aeda835c-6627-4f4c-ac73-9edcae95640b' \
-H 'Content-Type: application/json' \
--data-binary '{"attributes":{"name":"New Partner Name"}}' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
The successful request returns the serialized JSON copy of the created object together with the nested object.
{
"attributes": {
"name": "New Partner Name"
},
...,
"partner_sid": "ed437757-001d-4ecc-aa5a-efdf5e50dba0"
}
Sample
PATCH
request to add a newname2
record of the nestedattributes
object of the same Partner object.
curl -X PATCH \
'https://api.carrierx.com/core/v2/partners/aeda835c-6627-4f4c-ac73-9edcae95640b' \
-H 'Content-Type: application/json' \
--data-binary '{"attributes":{"name2":"New Partner Name 2"}}' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
The successful request returns the serialized JSON copy of the created object together with the modified nested object.
{
"attributes": {
"name": "New Partner Name"
"name2": "New Partner Name 2"
},
...,
"partner_sid": "ed437757-001d-4ecc-aa5a-efdf5e50dba0"
}
Sample
PATCH
request to modify the entire nestedattributes
object of the same Partner object.
curl -X PATCH \
'https://api.carrierx.com/core/v2/partners/aeda835c-6627-4f4c-ac73-9edcae95640b?nested_objects=replace' \
-H 'Content-Type: application/json' \
--data-binary '{"attributes":{"name3":"New Partner Name 3"}}' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
The successful request returns the serialized JSON copy of the created object together with the nested object.
{
"attributes": {
"name3": "New Partner Name 3"
},
...,
"partner_sid": "ed437757-001d-4ecc-aa5a-efdf5e50dba0"
}
PATCH
is used to modify only some of the object attributes and does not require to send the entire object in the request payload. Only the attributes and their values that need to be modified can be sent in the request body.
Objects can have a complex structure and can contain other objects as part of them, i.e., nested inside them. When you use PATCH
and want to modify the nested objects, PATCH
follows the below rules to define what must be updated and how:
-
If the existing nested object contains the same record (by key), the existing record will be replaced with the new value, provided in the
PATCH
request. The other nested object records will remain unmodified. -
If the existing nested object does not contain the same record, a new record will be added to the object. The other nested object records will remain unmodified.
-
If the existing nested object contains the same record and the value of the incoming record is
null
, then the existing record will be removed. The other nested object records will remain unmodified. -
If the
PATCH
request containsnested_objects=replace
as a query attribute, the whole nested object will be replaced with a new one (i.e., all the old records and their values will be removed and only the new ones will be added).
PUT
is used to modify the complete object and require to send the entire object (together with the nested objects, if there are any) in the request payload.
Both PATCH
and PUT
requests are aimed at a specific object and require the object secure ID as a part of the request path.
The successful PATCH
/PUT
request will return a 200
response with the serialized JSON copy of the modified object.
DELETE
The DELETE
method is used to delete the object targeted by its secure ID.
The successful DELETE
request will return a 204
response code with an empty body.
Additional Request Parameters
All CarrierX API requests require authentication. Refer to the section above for more information about obtaining login credentials. Endpoint credentials are passed using HTTP basic authentication. Pagination and filtering parameters are passed as part of the query URL. Object fields and values are added to the request body.
Responses
All responses are returned in the JSON format with a status code. For common errors returned, refer to the HTTP Errors section.
For a comprehensive list of returned attributes, refer to the Account, Call, and DID objects.
Pagination
This request returns Call objects starting with the second record available, and returns a maximum of 4 records.
curl -X GET \
'https://api.carrierx.com/conference/v1/calls?offset=2&limit=4' \
-u '[your_user_name]:[your_password]'
To view records not included in the response, make a request to the URL value of the previous key.
{
"count": 0,
"has_more": false,
"items": [],
"limit": 4,
"offset": 2,
"pagination": {
"previous": "https://api.carrierx.com/conference/v1/calls?limit=4&offset=0"
},
"total": 0
}
The three optional parameters for pagination are: offset
, limit
, and order
. GET
requests use these three parameters to dictate how many items should be skipped in the response, the amount of records to return, and in what order the results should appear.
offset
determines the amount of items that are skipped in the response. If there are five records and the offset
value is 2
, the response will not include the first two records. Instead, it will return records for items three through five. The default value for offset
is 0
, meaning that the first existing item will appear first.
The parameter limit
determines how many items are returned in the response. The default limit is 10
, meaning that a maximum of ten items will be returned. If the number of items that exist exceeds the limit
value, the has_more
value in the response will be set to true
. Responses also have a total
field, which is the total amount of results that match the search criteria. Note that the field total will be null
on objects that are uncountable, such as SMS messages.
The last parameter of pagination is order
. Two values are accepted for this parameter: asc
and desc
. asc
is short for ascending and is the default order. Enter the field name to be ordered followed by either asc
or desc
. For example, name desc
will return names sorted in reverse-alphabetical order. Since the default is asc
, entering just name will sort the results by name in alphabetical order.
The JSON response for a successful query using the pagination parameters offset
, limit
, and order
will include a pagination
parameter. The value of pagination
will be empty if there are no more records existing outside of the queried parameters. If there are existing records outside of the query, the pagination value will include next
or previous
URLs. These URLs can be used to obtain the remainder of the records available without modifying the original query. Simply construct another GET
request with the URL provided in this field.
Pagination Quick Reference
Parameter | Data Type | Description |
---|---|---|
limit | integer | The number of items to be shown in the response. The value entered should not exceed 1000 . 10 is the default value. This parameter and value are added to the query URL. |
offset | integer | The amount of items skipped in the response. 0 is the default value. This parameter and value are added to the query URL. |
order | string | The name of the field to be ordered followed by the order of the response data, either asc or desc . The field to be ordered is listed first, followed by the order value. For example: binding_sid desc . asc is the default order. This parameter and values are added to the query URL. |
Result Filtering
This
GET
request returns Endpoint objects that meet the filter criteria. In this case, we are narrowing results to theconference
endpoint type.
curl -X GET \
"https://api.carrierx.com/core/v2/endpoints?filter=type+eq+'conference'" \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
The following response includes all of the endpoints that fit the filter criteria.
{
"count": 1,
"has_more": false,
"items": [
{
"addresses": [],
"attributes": {},
"capacity": 0,
"endpoint_sid": "613325f8-bbb8-4599-b477-1b4fef3d017c",
"name": "my_example_conference",
"partner_sid": "6nelo9p3-3eef-4f75-8f48-fb98e99908be",
"properties": {
"account_sid": "bdrU77AFb-Y1sDwqqxkeb.M3LP7hSKYg",
"api_url": "https://api.carrierx.com/conference/v1",
"container_sid": "null",
"login": "username",
"password": "password"
},
"transformations": [],
"type": "conference",
"voip_token": null
}
],
"limit": 1000,
"offset": 0,
"pagination": {},
"total": 1
}
The filter
parameter is used to restrict or customize the JSON response. Operators can be combined for more specific searches, and are added to the query URL.
Result Filtering Quick Reference
Operator | Definition | Example |
---|---|---|
eq | equal to. This search looks for the exact value entered. In the example, results will have the exact "my_mediator" value for the name field. |
name eq "my_mediator" |
ge | greater than or equal to. This search returns records where the value is greater than or equal to the field listed. For example, records are returned where the value of wait_origination_did_ttl is greater than or equal to 70000 . |
wait_origination_did_ttl ge 70000 |
gt | greater than. This search returns records where the value is exceeded for the field listed. For example, records are returned where the value of maximum_ttl is greater than 40000 . |
maximum_ttl gt 40000 |
ilike | same functionality as like but case insensitive. |
name ilike "AccOUnt%" |
in | the current value of the specified field must be contained within the specified list. The following example will return records that have a status value of either "active" or "suspended" . |
status in ("active", "suspended") |
le | less than or equal to. This search returns records where the value is less than or equal to the field listed. For example, records are returned where wait_origination_did_ttl is less than or equal to 90000 . |
wait_origination_did_ttl le 90000 |
like | contains the value indicated in the string passed. % can be added anywhere as part of the string to indicate that there can exist text before or after the string parts. In the example, the command looks for a name starting with “Account”. This form of search is case sensitive. Note that this method of search will also work: name like "A%t" , and this search will yield records with name values beginning with A and ending in t . |
name like "Account%" |
lt | less than. This search returns records where the value is less than the field listed. For example, records are returned where maximum_ttl is less than 10000 . |
maximum_ttl lt 10000 |
ne | not equal to. This search returns records that do not include the "my_mediator" value for the name field. |
name ne "my_mediator" |
notin | not in. The current value of the specified field must not be in the specified list. The following example will return records that do not have a status value of "active" . |
status notin ("active") |
Field Filtering
In the following, we request Endpoint objects without the
properties
field.
curl -X GET \
'https://api.carrierx.com/mediator/v1/bindings?exclude_fields=properties' \
-u '[your_user_name]:[your_password]'
The following response excludes the
properties
field from returned Endpoint objects.
{
"count": 1,
"has_more": false,
"items": [
{
"addresses": [],
"attributes": {},
"capacity": 0,
"endpoint_sid": "613325f8-bbb8-4599-b477-1b4fef3d017c",
"name": "my_example_conference",
"partner_sid": "6nelo9p3-3eef-4f75-8f48-fb98e99908be",
"transformations": [],
"type": "conference",
"voip_token": null
}
],
"limit": 1000,
"offset": 0,
"pagination": {},
"total": 1
}
There are two parameters associated with field filtering: include_fields
, and exclude_fields
. By default, the fields included in JSON responses are specific to the request made. These returned fields are explained in the Object section for that object.
Refer to the specific object to determine which fields can be included and excluded from the JSON responses.
include_fields
and exclude_fields
accept comma-separated strings as values.
Field Filtering Quick Reference
Parameter | Data Type | Description |
---|---|---|
exclude_fields | string | The comma separated list of fields to be excluded from the response. The fields depend on the object. See the Object section for that object to see which fields return. |
include_fields | string | The comma separated list of fields to be included in the response. The fields depend on the object. See the Object section for that object to see which fields return. |
HTTP Errors
The FlexML API uses the following HTTP error codes:
Error Code | Message | Description |
---|---|---|
400 | Bad Request | The request could not be understood by the server due to malformed syntax. The client should not repeat the request without modifications. |
400 | No JSON object could be decoded | Generally an indicator that there is a syntax error. |
401 | Bad credentials | The request requires correct user authentication. |
401 | Unauthorized | The request requires user authentication. |
403 | Forbidden | The server understood the request, but is refusing to fulfill it. Authorization will not help and the request should not be repeated. |
404 | Cannot find (binding, item, dialout) by SID | The SID number does not exist. Verify that the SID has been entered correctly. Note that calls can expire. |
404 | Not Found | The requested resource was not found on the server. |
409 | Cannot find redirect_did |
The redirect_did could not be found. Verify that there are available DIDs that can be assigned as redirect_did automatically or assign it manually using the Mediator API Create Binding method. |
415 | Unsupported media type | Ensure that the header includes support for the content type JSON. |
500 | Internal server error | The server encountered an unexpected condition which prevented it from fulfilling the request. |
FlexML Call Flow
FlexML instructions are used to create custom call flows for both inbound and outbound calls. This section goes over requests, responses, and status callbacks.
FlexML Requests
For inbound calls, the url
and method
from the DID object will be used. If the url
value in the DID object is not set, then the url
and method
values from the Account object will be used instead.
For outbound calls, these values are set in the Call object. CarrierX will make a request to the URL provided, and expects to receive FlexML instructions in the response. These instructions contain a set of ordered commands that will be used to handle the call. The method
value is the type of request that will be made to the url
, either POST
or GET
.
Request Data
Successful requests return a JSON response that looks like the following:
{
"AccountSid":"",
"ApiVersion":"2.0",
"CallerName":"",
"CallSid":"4695bc4a0932bcd2e99492e523db9ee2",
"CallStatus":"completed",
"Direction":"inbound",
"From":"15162065338",
"OriginalFrom":"+15162065338",
"OriginalTo":"15162065337",
"RequestUrl":"https://sampleurl.com/example",
"To":"15162065337"
}
Data about the call will be passed in the request body in JSON format if the method
is POST
. Data will be passed as query parameters if the method
is GET
.
Attribute | Data Type | Description |
---|---|---|
AccountSid | string | The account secure ID. This field is not yet supported and will be blank. |
ApiVersion | string | The API version used to make the call. |
CallerName | string | The CNAM of the caller. |
CallSid | string | The call secure ID. This value will remain the same throughout the duration of the call. |
CallStatus | string | Denotes if an error has occurred. Refer to the table below for a list of values that appear in this field. |
Direction | string | Denotes whether the call was inbound or outbound. |
ForwardedFrom | string | Contains the phone number in the Diversion header, if present. This is used in cases such as conditional call forwarding. Note that not all carriers support passing this information in the header. |
From | string | The calling party phone number, in E.164 format. |
OriginalFrom | string | The calling party phone number in raw format, received directly from the carrier. Note that in development, From will generally be used. |
OriginalTo | string | The phone number that was dialed in raw format, received directly from the carrier. Note that in development, To will generally be used. |
RequestUrl | string | The URL of the FlexML that was running to trigger the current request. |
To | string | The phone number that is dialed, in E.164 format. |
CallStatus Values
The following are values that appear in the CallStatus
field.
Value | Description |
---|---|
busy | There was a busy signal. |
cancel | The caller canceled the call instead of answering it. |
completed | The call was answered normally. |
failed | The call failed to go through. There are a number of reasons why this can happen, including that the phone number was not valid or all channels were busy. |
noanswer | There were too many rings without an answer. |
In addition to the Request Data described in the table above, data can also include the URL holding the recording audio and the duration of the recording in seconds. Callback data depends on the type of FlexML instructions being executed.
Please refer to the individual verb sections for additional data returned when using those verbs.
FlexML Responses
The response to the CarrierX request should include FlexML instructions. Each set of FlexML instructions is wrapped within Response
wrapper start and end tags. Tags nested inside of Response
tags are called verbs, and attributes that modify these verbs are simply referred to as supported attributes. The verbs are executed from top to bottom. However, some instructions will break the flow, and the remainder of the verbs will not be executed.
Sample FlexML
<Response>
<Gather action="/path/to/handler" timeout="5">
<Say>Please enter the extension of the party you would like to reach. </Say>
</Gather>
<Say>You did not enter an extension. </Say>
<Hangup />
</Response>
In this example, once the call has been connected, the called party will be prompted by the Say
message to enter the extension of the party they are trying to reach. The called party has five seconds to enter the extension because timeout
is set to 5
. If digits are entered, the action
URL will be requested, and the FlexML instructions at that URL will be executed. The rest of the FlexML instructions in the current instructions will be ignored.
If the called party does not enter digits after the 5
seconds has elapsed, the instructions will proceed to the Say
verb below Gather
. Then the Hangup
verb will be executed.
Status Callbacks
Data about completed calls can be received by setting status_callback_url
and status_callback_method
in the Call object or the DID object. The response to this request is not used. If a status_callback_url
is set on both the Call object and DID object, the URL set on the Call object will be used.
The status_callback_url
and status_callback_method
can also be overridden using the Override
verb in a FlexML response. Please refer to the Override section for more information.
Request Data
Successful requests return a JSON response that looks like the following:
{
"AccountSid":"",
"ApiVersion":"2.0",
"CallDuration":8,
"CallerName":"",
"CallSid":"4695bc4a0932bcd2e99492e523db9ee2",
"CallStatus":"completed",
"Direction":"inbound",
"From":"15162065338",
"OriginalFrom":"+15162065338",
"OriginalTo":"15162065337",
"PlaybackUrl":"https://storage.carrierx.com/f/5fac56c8-c9fa-4d0e-bf88-f114e0d0cfab.mp3",
"PlayOffset":37,
"RequestMethod":"GET",
"RequestUrl":"https://sampleurl.com/example",
"To":"15162065337"
}
These status callback fields are in addition to the fields listed in the Requests section.
Attribute | Data Type | Description |
---|---|---|
CallDuration | integer | The duration of the call in seconds. |
PlaybackUrl | string | The URL of the file that was played. |
PlayOffset | integer | The position of the playback from the beginning of the file when the call ends (either played or skipped to using DTMF controls). |
RequestMethod | string | The type of request made to the RequestUrl , either POST or GET . |
RequestUrl | string | The initial URL to which the request was made, as set in the Call object or DID object. |
FlexML Syntax
FlexML, the CarrierX markup language, is used to create instructions for call logic.
The language is much like XML. It consists of special words included into opening and closing tags. Some of the tags are self-closing, i.e., they do not require a closing tag. Some of the tags can contain additional attributes in the start-tag. And some of the tags can nest values and even other tags between opening and closing tags.
The basic components of the markup language are verbs and nouns.
FlexML Verbs
FlexML verbs specify what type of action will be performed. Since the instructions are executed from top to bottom, the verbs should be ordered as such. Verbs are modified using supported attributes.
Amd (experimental)
In this example, the
Amd
verb will attempt to detect whether or not the other party is human or machine. If no greeting has been made before5
seconds, the other party is determined to be machine. If the greeting exceeds2
seconds, then the other party is determined to be machine. Additionally, the other party is determined to be human if the post-greeting silence exceeds0.5
seconds.
When a determination has been made, or the
totalAnalysisTime
of10
seconds has elapsed, a callback will be sent to the action URL viaPOST
method.
<Response>
<Amd action="/api/v1/call-control/message/amd/15162065340"
method="POST"
initialSilence="5000"
greeting="2000"
afterGreetingSilence="500"
totalAnalysisTime="10000" />
</Response>
The experimental Amd
verb attempts to determine whether the other party is human or machine. The determination of the other party’s status will be returned in a callback and possible returned values will be as follows.
AMD Callback Attributes
Attribute | Data Type | Description |
---|---|---|
AMDCause | string | The reasoning for the determination of AMDStatus . |
AMDStatus | string | The determination made about the other party, whether they are HUMAN or MACHINE . Alternatively, the determination can also be NOTSURE or HANGUP . Please refer to the table below for values that can be returned. |
AMDStatus Values
These values can be returned as AMDStatus
.
Value | Description |
---|---|
HANGUP | The other party hung up before a determination could be made. |
HUMAN | The other party is determined to be human. |
MACHINE | The other party is determined to be machine. |
NOTSURE | It was not determined definitively whether the other party is human or machine. |
Supported Attributes
These attributes can be used to modify the Amd
verb. They are inserted as name-value pairs in the start-tag.
Attribute | Data Type | Description |
---|---|---|
action | string | Control is passed to this URL after the determination is made whether the other party is human or machine. |
afterGreetingSilence | integer | The length of silence in milliseconds after a greeting is detected. If this number of seconds is exceeded, then the other party is determined to be human. |
betweenWordSilence | integer | The minimum duration in milliseconds of silence after a word to consider the following audio a new word. |
greeting | integer | The maximum length in milliseconds of a greeting. If this number of seconds is exceeded, the other party is determined to be machine. |
initialSilence | integer | The maximum duration of silence in milliseconds before the greeting will begin. If this second value is exceeded, the other party is determined to be machine. |
maximumNumberOfWords | integer | The maximum number of words in the greeting. If this value is exceeded, the other party is determined to be machine. |
maximumWordLength | integer | The maximum duration of voice in milliseconds to be considered a word. |
method | string | The type of request made to the action URL, either POST or GET . |
minimumWordLength | integer | The minimum duration of voice in milliseconds to be considered a word. |
silenceThreshold | integer | A number between 0 and 32767 that is used as the maximum level of noise to be considered silence. |
totalAnalysisTime | integer | The maximum duration in milliseconds allowed for the algorithm to decide whether the other party is human or machine. |
Dial
To simply dial the number, include it directly inside the
Dial
verb without using theNumber
noun. In this case, FlexML instructions cannot include any additional parameters for the dialed number. In this example, the phone number inside theDial
tags will be dialed. The call total time will be limited to15
seconds. The called party will be able to hang up by pressing the*
key. If an action URL is added to theDial
verb as an attribute, a request will be made to that URL if the phone number cannot be reached, or when the call ends.
<Response>
<Dial timeLimit="15" hangupOnStar="true">15162065340</Dial>
</Response>
The Dial
verb connects the calling party with the dialed party. Once the call is set up, the participants can start talking.
When the call is ended successfully, or the dialed number is not reached, or the call is terminated, CarrierX will make a POST
or GET
request to the action
URL.
If no action
URL is set, the call flow will move to the next verbs in the FlexML instructions.
Supported Attributes
These attributes can be used to modify the Dial
verb. They are inserted as name-value pairs in the start-tag.
Attribute | Data Type | Description |
---|---|---|
action | string | The link to another set of FlexML instructions. A request will be made to this URL when the call is ended or if the dialed party is not available. If no action URL is set, the rest of the verbs in the current FlexML instructions will be executed. The URL can be absolute or relative. |
callerId | string | The phone number that will appear on the caller ID of the called party. This phone number must be on the account, or have custom permission set up. |
callerName | string | The caller CNAME that is used in the from field. |
confirmKey | string | The key that the called party must press to start the phone talk. Values accepted in this field are: 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 0 , # , and * . |
confirmSound | string | The URL of the audio that contains the instructions for the key from the confirmKey field. It informs the called party which key they must press to start the talk. |
containerSid | string | The secure ID of the container to which the recording will be written. |
hangupOnStar | boolean | If this value is set to true , pressing * will hang up the call with the dialed number, and continue with the next FlexML instructions. Until * is pressed, the rest of the FlexML instructions will not be executed. |
method | string | The type of request made to the action URL. Values accepted in this field are POST or GET . The default value is POST . |
record | string | Determines whether or not to record the outbound call until hangup. Values accepted in this field are:
do-not-record . |
recordDirection | string | The direction of the call that will be recorded. Values accepted in this field are:
any . |
recordingStatusCallback | string | A callback is sent to this URL after the recording has ended. |
recordingStatusCallbackEvent | string | The comma-separated list of events to be notified about. Options are completed , to indicate that the recording is successful, and failed , to indicate that the recording has failed. The default value is "completed,failed" . |
recordingStatusCallbackMethod | string | The method, either POST or GET that the callback to recordingStatusCallback is sent. The default value is POST . |
ringing | string | Phone ringing management. Values accepted in this field are:
|
timeLimit | integer | The maximum number of seconds that the call will last. The default value is 0 , meaning that the call time is not limited. |
timeout | integer | The number of seconds to wait for the destination number to answer. After the call times out, a request is made to the action URL. The default value is 30 . |
trim | string | Determines whether or not silence is removed from the beginning or ending of a recording. To trim the silence in the recording, set this field to trim-silence . The default value is do-not-trim . |
Use Number Noun
You can also place a phone number inside the Number
noun. This is done to allow specifying the additional parameters (e.g., sendDigits
) when dialing a phone number. Refer to the this section for more information about the Number
noun.
Additionally, you can use the Number
noun for the simultaneous ring to several numbers feature.
Simultaneous Ring to Several Numbers
In this example, the phone numbers in the
Number
tags will be dialed all at the same time. The first person to answer is connected to the caller.
<Response>
<Dial>
<Number>12345645585</Number>
<Number>96846465465</Number>
<Number>98133217461</Number>
</Dial>
</Response>
CarrierX supports dialing to several numbers at once. You need to specify the numbers in the Number
noun tags inside the Dial
verb. The first person to answer will be connected to the caller. The calls to the other numbers will be hung up.
Dtmf
In these sample FlexML instructions, the phone number in the
Dial
verb is dialed, and then the characters within theDtmf
tags are entered. Each comma within theDtmf
tag is a0.5
-second delay.
<Response>
<Dial timeLimit="15" hangupOnStar="true">
<Number>15162065340</Number>
</Dial>
<Dtmf>,,,,12</Dtmf>
</Response>
The Dtmf
verb enters the symbols within its tags. This can be useful when dialing a phone number with an extension.
Values accepted for the Dtmf
verb are: 0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, #
, *
, ,
, and the combinations of these characters. Each comma character defines a 0.5-second delay.
Gather
In these sample FlexML instructions, once the party is reached, the called party will be prompted by verbal command to enter some digits. If an
action
URL is set, the URL will be queried once DMTF input has been gathered according to the specifications. In this case, if theaction
URL was set, it would be requested once the party has entered two digits becausenumDigits
is set to2
.
<Response>
<Gather numDigits="2">
<Say>Please enter the extension of the party you'd like to be connected to. </Say>
</Gather>
</Response>
Say
will read out the text within its tags.
<Response>
<Gather timeout="10" numDigits="2" method="get" action="/<file>.xml">
<Say>Please enter two digits</Say>
</Gather>
</Response>
Play
will play the file within its tags.
<Response>
<Gather timeout="10" numDigits="2" method="get" action="/<file>.xml">
<Play>http://<file>.wav</Play>
</Gather>
</Response>
The Gather
verb collects the digits that a caller enters into the phone keypad. The entered data from the keypad is passed to the action
URL. In the case that no input has been entered, the call will move to the next verb in the FlexML instructions.
The Say
and Play
verbs can be nested in the Gather
verb. These are the only two verbs that can be nested within another verb.
Supported Attributes
These attributes can be used to modify the Gather
verb. They are inserted as name-value pairs in the start-tag.
Attribute | Data Type | Description |
---|---|---|
action | string | The link to another set of FlexML instructions that will be called after the input has been submitted, or when the timeout value has expired. The URL can be absolute or relative. |
finishOnKey | string | This determines the single key that will act as the submit key. If no finishOnKey value is specified, the input will be submitted after the timeout is expired. Values accepted in this field are: 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , # , * . To disable this feature, add the _ value. The default value is # . |
method | string | The type of request made to the action URL. Values accepted in this field are POST or GET . The default value is POST . |
numDigits | integer | The expected number of digits to be entered in order to submit data to the action URL. Integers entered into this field must be greater than or equal to 1 . If the field value is not specified, any number of digits will be listened for. Other actions will be listened to, such as timeout and finishOnKey , to end the input. |
timeout | integer | The number of seconds to wait for the caller’s next input before moving to the action URL request. Note that this is the time allotted between individual DTMF input, not the total time allotted to enter all values. If there is a nested verb such as Play within the Gather verb, the timeout will begin after the end of that verb. For example, if you have a Play URL, the playback will play through and then the timeout value will begin. The default value is 5 . |
validDigits | string | The list of the digits (tone keys, which the user can press) that will be recognized by the Gather verb. Any key outside this list will be ignored. The default value is 1234567890#*abcdABCD . |
Request Data
Successful requests return a JSON response that looks like the following:
{
"AccountSid":"",
"ApiVersion":"2.0",
"CallerName":"",
"CallSid":"4695bc4a0932bcd2e99492e523db9ee2",
"CallStatus":"completed",
"Digits": "",
"Direction":"inbound",
"From":"15162065338",
"OriginalFrom":"+15162065338",
"OriginalTo":"15162065337",
"RequestUrl":"https://sampleurl.com/example",
"To":"15162065337"
}
The following is an additional parameter and value that will be included in action
requests.
Attribute | Data Type | Description |
---|---|---|
Digits | string | The digits entered via DTMF. |
Hangup
The following will hang up on the caller. Instructions after the
Hangup
verb will not run.
<Response>
<Hangup/>
</Response>
Hangup
will answer the call and then immediately hang up. To reject the call without answering, use Reject
instead.
Override
The following is re-assigning the
statusCallbackUrl
andstatusCallbackMethod
for this specific set of instructions.
<Response>
<Override statusCallbackUrl="http://www.example.com/path/to/handler" statusCallbackMethod="GET" />
<Play streaming="true" timeLimit="30">
http://www.example.com/path/to/media.mp3
</Play>
</Response>
This verb is added to the top of FlexML instructions and the URL passed will override the status_callback_url
and status_callback_method
of the Call object for that specific call.
Supported Attributes
These attributes can be used to modify the Override
verb. They are inserted as name-value pairs in the start-tag.
Attribute | Data Type | Description |
---|---|---|
statusCallbackMethod | string | The method to override the status_callback_method value. |
statusCallbackUrl | string | The URL to override the status_callback_url value. |
Pause
In this example, the called party will hear a welcome message, followed by a 15-second pause. Then the thank you message will play.
<Response>
<Say>Welcome</Say>
<Pause length="15"/>
<Say>Thank you for your time.</Say>
</Response>
Pause
stops the next verb in the FlexML instructions from executing before the number of seconds has elapsed. The Pause
verb is the same as the Wait
verb.
Supported Attributes
These attributes can be used to modify the Pause
verb. They are inserted as name-value pairs in the start-tag.
Attribute | Data Type | Description |
---|---|---|
length | integer | The pause duration in seconds. Integers entered into this field must be greater than or equal to 1 . The default value is 1 . |
minNoise | integer | The amount of time in milliseconds when some audio is received from the other end and considered to be noise. This field and value are only applicable when noise is set to true . |
minSilence | integer | The amount of time in milliseconds where no voice or audio is received from the other end to be considered silence. This field and value are only applicable when silence is set to true . |
noise | boolean | Determines whether or not noise detection is on. If set to true , Pause will end after a period of noise is detected. If set to false or there is no noise noise detected, Pause will wait the full amount of time specified in the length attribute. The default value is false . |
silence | boolean | Determines whether or not silence detection is on. If set to true , Pause will end after a period of silence is detected. If set to false or there is no silence detected, Pause will wait the full amount of time specified in the length attribute. The default value is false . |
In this example, the caller will hear a welcome message and will be asked to say something. After that the wait for the audio input from the caller (with a maximum delay of 15 seconds before giving up) will start.
<Response>
<Say>Welcome</Say>
<Say>Please announce yourself</Say>
<Pause noise="true" minNoise="2000" silence="true" minSilence="2500" length="15" />
</Response>
Let’s say, the caller starts talking five seconds after the call started and speaks for four seconds. This means that waiting for the audio took nine seconds totally (five of initial silence + four of audio), the remaining time will be spent on waiting for silence, and is equal to six seconds maximum. If 2.5-seconds silence follows, the whole pause will be 11.5 seconds. After that FlexML switches to the next instructions.
Refer to the code example for more detailed information on this.
Play
These FlexML instructions will play the file for the maximum duration of 30 seconds.
<Response>
<Play timeLimit="30">
http://www.example.com/path/to/media.mp3
</Play>
</Response>
The same result can be achieved if
file_sid
is used together with theFile
noun instead of the direct link.
<Response>
<Play timeLimit="30">
<File>d620ec24-acd8-4193-9249-b89f46ee3654</File>
</Play>
</Response>
Play
will play a file to the caller. There are two ways to specify the file to be played:
- pass the file URL between the
Play
tags; - nest the File noun inside the
Play
verb and use thefile_sid
attribute of the File object which can be obtained using the Get Files request.
Once the file stops playing, CarrierX will make a POST
or GET
request to the action
URL.
If no action
URL is set, the call flow will move to the next verbs in the FlexML instructions.
If the Play
file fails to play, a POST
or GET
request will be sent to the errorAction
URL.
Supported Attributes
These attributes can be used to modify the Play
verb. They are inserted as name-value pairs in the start-tag.
Attribute | Data Type | Description |
---|---|---|
action | string | The URL containing the executable FlexML instructions that will be requested after the Play file ends. |
background | boolean | Playback occurs in the background if this value is set to true . The audio file will continue to play, but control will pass to the next verb. The default value is false . |
controlSkip | integer | The amount of seconds skipped for forwardOnKey and rewindOnKey . Integers entered into this field must be greater than or equal to 1 . The default value is 60 . |
digits | string | This attribute provides an alternate syntax for the Dtmf verb and will enter the digits provided as a string. Note that this attribute should be used alone with the Play verb, and no URL should be included between the Play tags. Other supported attributes should be used with their own Play verb. |
errorAction | string | The URL containing the executable FlexML instructions that will be requested if the Play file fails. |
errorMethod | string | The method used to request the errorAction URL containing the executable FlexML instructions if the Play file fails. This method can be set as either POST or GET . The default value is POST . |
forwardOnKey | string | Entering the value of this field on a keypad will fast forward the recording by the number of seconds set in controlSkip . Values accepted in this field are: 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , # , and * . |
informationAudioUrl | string | The audio that will play when informationOnKey is pressed. After this file has been played once, normal playback resumes. |
informationOnKey | string | If this key is pressed, audio is paused and informationAudioUrl is played. Values accepted in this field are: 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , # , and * . |
loop | integer | The number of times that the file will be played. Integers entered into this field must be greater than or equal to 1 . Setting this field to 0 will make the file play repeatedly until the call is ended. The maximum value accepted in this field is 100 . The default value is 1 . |
loopPause | integer | The number of seconds between each repetition. Integers entered into this field must be greater than or equal to 1 . The maximum value accepted in this field is 300 . The default value is 0 , meaning that there will be no pause between repetitions. |
method | string | The HTTP method used to execute the request to the action URL. This method can be set as either POST or GET . The default value is POST . |
minorControlSkip | integer | The amount of seconds skipped for minorForwardOnKey and minorRewindOnKey . Integers entered into this field must be greater than or equal to 1 . The default is 60 . |
minorForwardOnKey | string | Entering the value of this field on a keypad will fast forward the recording by the number of seconds set in minorControlSkip . Values accepted in this field are: 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , # , and * . |
minorRewindOnKey | string | Entering the value of this field on a keypad will rewind the recording by the number of seconds set in minorControlSkip . Values accepted in this field are: 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , # , and * . |
pauseAudioUrl | string | The audio to play while playback is paused by pauseOnKey . This audio is played on loop. There is a default comfort noise. |
pauseOnKey | string | Used to pause the playback of the recording by pressing one of the keys. Values accepted in this field are: 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , # , and * . |
preBuffer | integer | The time in seconds that the remote file should be queued before playback is started, to avoid playback catching up with a download in progress. The default value is 0 . |
restartOnKey | string | Used to restart the paused playback by pressing one of the keys. Values accepted in this field are: 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , # , and * . |
rewindOnKey | string | Entering the value of this field on a keypad will rewind the recording by the number of seconds set in controlSkip . Values accepted in this field are: 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , # , and * . |
skip | integer | The time in seconds into a file that it will start playing. |
stopOnKey | string | Used to stop the playback by pressing one of the keys. Values accepted in this field are: 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , # , and * . Note that you can enter multiple values in this field. For example, if you add the 3* value, then you will be able to stop the playback by entering either 3 or * . |
streaming | boolean | Allows to play the stream file defined in the URL parameter. Set the value to false if the URL is a prerecorded file, and true if the URL has a real-time recording. Note that setting the streaming value to true will disable forwardOnKey and rewindOnKey . Refer to the sections below for information about supported file formats and protocols. The default value is false . |
strictForwardControl | boolean | Does not allow forwardOnKey to reach the end of the file if this value is set to true . A forward command that moves past the end of the file is ignored. The default value is false . |
timeLimit | integer | The number of seconds that the recording will playback when streaming is set to true . Integers entered into this field must be greater than or equal to 1 . The default value is 0 , meaning that the time is not limited. |
waitInitial | integer | If the initial download is slow and the initial playback cannot start before this number of seconds, waitInitialUrl will start playing. |
waitInitialUrl | string | The file to play for the waitInitial attribute. |
waitRepeat | integer | After waitInitial has elapsed, and if the playback does not start in this number of seconds, waitRepeatUrl will start playing. Repeat every waitRepeat seconds until Play starts. |
waitRepeatUrl | string | The file to play for waitRepeat . |
Request Data
Successful requests return a JSON response that looks like the following:
{
"AccountSid":"",
"ApiVersion":"2.0",
"CallerName":"",
"CallSid":"4695bc4a0932bcd2e99492e523db9ee2",
"CallStatus":"completed",
"Digits":"",
"Direction":"inbound",
"From":"15162065338",
"OriginalFrom":"+15162065338",
"OriginalTo":"15162065337",
"PlaybackUrl":"https://storage.carrierx.com/f/5fac56c8-c9fa-4d0e-bf88-f114e0d0cfab.mp3",
"PlayOffset":37,
"RequestUrl":"https://sampleurl.com/example",
"To":"15162065337"
}
Attribute | Data Type | Description |
---|---|---|
Digits | string | If the playback was stopped due to stopOnKey , this is the key that triggered the end of the playback. This value will be empty if the playback ended normally. |
PlaybackUrl | string | The URL of the file that was played. |
PlayOffset | integer | The position of the playback from the beginning of the file when the call ends (either played or skipped to using DTMF controls). |
Supported File Formats
These are the format types that will be able to play: aac
, al/alaw
, flac
, g722
, m3u8
, mp3
, mp4/mp4a
, ogg
, ul/ulaw
, and wav
Supported Protocols
The audio streaming protocols are hls
, http
, https
, and rtmp
.
http
andhttps
are supported whenstreaming
is set totrue
orfalse
.- Use
hls
orrtmp
to play streaming files only.
Record
In this example, a background recording begins because
recordSession
is set totrue
. The recording is saved in the specifiedcontainerSid
. Note that by default, the container used to store the recording will be the one specified in the Endpoint object. However, the container can be overridden by assigning acontainerSid
, as is shown here. The system will automatically generate a file inside the container, unless afileSid
is specified. The recording will fail if the container or file does not exist or is full.
<Response>
<Record containerSid="ea55039a-3ee4-48cd-a1ff-dfb7751f1cec" recordSession="true"></Record>
<Say>Thank you for calling. </Say>
</Response>
The Record
verb records the conversation and stores it as an audio file in the specified container. Once the recording has ended, CarrierX will make a POST
or GET
request to the action
URL.
If no action
URL is set, the call flow will move to the next verbs in the FlexML instructions. If the recording fails, a POST
or GET
will be sent to the errorAction
URL.
Supported Attributes
These attributes can be used to modify the Record
verb. They are inserted as name-value pairs in the start-tag.
Attribute | Data Type | Description |
---|---|---|
action | string | The link to another set of FlexML instructions. This is the link that will be requested after the recording has finished. URLs entered into this field can be absolute or relative. The type of request to this URL is set as the method value. Note that if there is no recording or the recording was empty after silence trim (if it was enabled), action does not execute and the next verb following is executed. |
backgroundAudioLoop | integer | This attribute defines how many times backgroundAudioUrl will be repeated. |
backgroundAudioUrl | string | This audio file plays during the recording, but is not recorded. For example, the called party will hear this file, but the recording will only include the audio from the caller side. |
callbackUrl | string | The URL for the callback. Setting the callbackUrl will enable accessing data about the recording after it has ended. |
containerSid | string | The secure ID of the storage container. If a fileSid is specified, this containerSid should be left blank and will be ignored. |
direction | string | Determines which leg of the call to record. Values accepted in this field are:
any , meaning that both legs are recorded. |
errorAction | string | The URL containing the executable FlexML instructions that will be requested if the recording fails. |
errorMethod | string | The method used to request the errorAction URL containing the executable FlexML instructions if the recording fails. |
fileFormat | string | Set as the type of file that will be stored as a recording. Accepted file formats are wav , mp3 , and ul . The default value is wav . |
fileMode | string | This value defines whether new recordings will be appended to the storage file, or will overwrite the existing recordings in the file. Values accepted in this field are append and overwrite . The default value is append . |
fileSid | string | The secure ID of the storage file that the recording should be saved to. This is an existing file specified that will override any specified containerSid . |
finishOnKey | string | The key to press to end the recording. Values accepted in this field are: 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , # , and * . By default, pressing any valid key will end the recording. The none string value can be passed to disable this feature. Note that multiple values can be passed into a single string. For example, if the 123 string is passed as the finishOnKey value, then pressing 1 , 2 , or 3 will end the recording. |
integerKey1 | integer | An optional integer identifier that can be used for referential purposes. This value is stored as the integer_key_1 value in the File object. |
integerKey2 | integer | An optional integer identifier that can be used for referential purposes. This value is stored as the integer_key_2 value in the File object. |
lifecycleAction | string | An action that will be performed for the recording file once the lifecycleTtl value is exceeded. The default value is delete . |
lifecycleTtl | integer | The time in seconds before the lifecycleAction is executed for the recording file. |
maxLength | integer | The maximum length of the recording, in seconds. Integers entered into this field must be greater than or equal to 1 . |
method | string | The type of request made to the action URL. Values accepted in this field are POST or GET . The default value is POST . |
playBeep | boolean | Plays a beep sounds to indicate that a recording has started. If set to false , no beep sound is played. The default value is false . |
recordingStatusCallback | string | The URL where the callback will be sent after the recording has ended. |
recordingStatusCallbackMethod | string | The method, either POST or GET , that the callback to recordingStatusCallback is sent. The default is POST . |
recordSession | boolean | If this attribute is set to true , the whole session will be recorded in the background. The default value is false . |
stringKey1 | string | An optional string identifier that can be used for referential purposes. This value is stored as the string_key_1 value in the File object. |
stringKey2 | string | An optional string identifier that can be used for referential purposes. This value is stored as the string_key_2 value in the File object. |
timeout | integer | The number of seconds of silence allowed before the recording is terminated. Integers entered into this field must be greater than or equal to 1 . The default value is 5 . |
transcribe | boolean | Transcribes the audio to the human readable text representation. The default value is false . Please note that this is a paid feature. Contact technical support at support@carrierx.com for more information about this. |
transcribeCallback | string | The URL where the callback will be sent after the transcription is finished. |
transcribeLowConfidenceWordReplacement | string | The word or character that will be used to replace the words with low confidence (that was hard to recognize for the system) in the resulting transcription. The default value is _ . |
transcribeLowConfidenceWordThreshold | number | The confidence level below which the word is considered unrecognized and is replaced with the transcribeLowConfidenceWordReplacement word/character. Values accepted in this field are numbers between 0 and 1 . The default value is 0.01 . |
transcribeTimeout | integer | The time in seconds during which the system will wait for the transcription callback. If this time is exceeded and no transcription is ready, the system will send the callback with the timeout status. |
trim | string | Determines whether or not silence is removed from the beginning or ending of a recording. To keep the silence in the recording, set this field to do-not-trim . The default value is trim-silence . |
Supported External Storage
The following external storage services are supported to store the recording data:
You will need to provide the credentials and specify the storage location for each of the external storage used. Only one external storage can be used at a time. Refer to the tables below to learn what parameters you need to specify for each storage type.
In this example, the background recording is saved to the specified
awsBucketName
of Amazon S3.
<Response>
<Record recordSession="true" awsAccessKey="_AWS_ACCESS_KEY_" awsBucketName="_AWS_BUCKET_NAME_" awsSecretKey="_AWS_SECRET_ACCESS_KEY_"></Record>
<Say>Thank you for calling. </Say>
</Response>
Amazon Simple Storage Service
Attribute | Data Type | Description |
---|---|---|
awsAccessKey required |
string | The access key used to access AWS S3. |
awsBucketName required |
string | The bucket name where the recording will be stored. |
awsSecretKey required |
string | The secret key used to access AWS S3. |
In this example, the background recording is saved to the specified
gcpBucketName
Google Cloud Platform.
<Response>
<Record recordSession="true" gcpAccessToken="_GCP_ACCESS_TOKEN_" gcpBucketName="_GCP_BUCKET_NAME_" gcpProject="_GCP_PROJECT_"></Record>
<Say>Thank you for calling. </Say>
</Response>
Google Cloud Platform
Attribute | Data Type | Description |
---|---|---|
gcpAccessToken | string | The access token used to access Google Cloud Platform. This attribure is only required if you do not specify gcpRefreshToken , gcpClientId , and gcpClientSecret . |
gcpBucketName required |
string | The bucket name where the recording will be stored. |
gcpClientId | string | The client ID used to access Google Cloud Platform. This attribute is only required if you do not specify gcpAccessToken . |
gcpClientSecret | string | The client secret used to access Google Cloud Platform. This attribute is only required if you do not specify gcpAccessToken . |
gcpProject required |
string | The project that will be used to store the recording. |
gcpRefreshToken | string | The refresh token used to access Google Cloud Platform. This attribute is only required if you do not specify gcpAccessToken . |
In this example, the background recording is saved to the specified
azureContainerName
of Microsoft Azure Blob Storage.
<Response>
<Record recordSession="true" azureAccountKey="_AZURE_ACCOUNT_KEY_" azureAccountName="_AZURE_ACCOUNT_NAME_" azureContainerName="_AZURE_CONTAINER_NAME_"></Record>
<Say>Thank you for calling. </Say>
</Response>
Microsoft Azure Blob Storage
Attribute | Data Type | Description |
---|---|---|
azureAccountKey | string | The account key used to access Microsoft Azure Blob storage. This attribute is only required if you do not specify azureSasToken . |
azureAccountName required |
string | The account name used to access Microsoft Azure Blob storage. |
azureContainerName required |
string | The container name where the recording will be stored. |
azureSasToken | string | The SAS token used to access Microsoft Azure Blob storage. This attribute is only required if you do not specify azureAccountKey . |
Callback Returned Data
Successful requests return a JSON response that looks like the following:
{
"AccountSid":"",
"ApiVersion":"2.0",
"CallSid":"4695bc4a0932bcd2e99492e523db9ee2",
"CallStatus":"completed",
"Direction":"inbound",
"From":"15162065338",
"OriginalFrom":"+15162065338",
"OriginalTo":"15162065337",
"RecordingDuration": 60,
"RecordingSid": "ea662226-9f71-44fe-858f-f8b624034974",
"RecordingUrl": "https://storage.carrierx.com/f/ea662226-9f71-44fe-858f-f8b624034974",
"To":"15162065337",
"TranscriptionSid": "cac8582f-db8a-4c4d-82e5-3e8026435a54",
"TranscriptionStatus": "completed",
"TranscriptionText": "This is a transcribed recorded call text",
"TranscriptionUrl": ""
}
The following are additional parameters and values that will be returned in action
requests.
Attribute | Data Type | Description |
---|---|---|
RecordingDuration | integer | The length in seconds of the recording. |
RecordingFileSid | string | The secure ID of the recording file. This can be used with the CarrierX Storage API. |
RecordingUrl | string | The URL where the recording is located. |
TranscriptionSid | string | The identifier of the transcription file. |
TranscriptionStatus | string | The status of the transcription. |
TranscriptionText | string | The complete text of the recorded call transcription. |
TranscriptionUrl | string | The publicly accessible URL of the transcription. Currently, this field is a placeholder and not used. |
Redirect
In this example, the flow of the call will be redirected to the URL specified in the
Redirect
tags. This URL is requested using theGET
method. TheSay
instruction afterRedirect
is ignored.
<Response>
<Redirect method="GET">http://www.example.com/path/to/handler</Redirect>
<Say>Thank you</Say>
</Response>
The Redirect
verb turns over the control of the call flow to another set of FlexML instructions located at a different URL.
Attribute | Data Type | Description |
---|---|---|
method | string | The type of request made to the action URL. Values accepted in this field are POST or GET . The default value is POST . |
Reject
In this example, the call will be immediately rejected and the reject message to the carrier will be
busy
.
<Response>
<Reject reason="busy"></Reject>
</Response>
The Reject
verb does not answer a call, but instead rejects it. To ensure the incoming call is unanswered, put Reject
as the first verb in Response
.
Supported Attributes
These attributes can be used to modify the Reject
verb. They are inserted as name-value pairs in the start-tag.
Attribute | Data Type | Description |
---|---|---|
reason | string | The reason for rejecting a call. This internal data is sent to the carrier, which determines the handling behavior. Values accepted in this field are: busy , busy-here , decline , does-not-exist , forbidden /rejected , not-found , and redirect . Refer to the table below for the explanation of each reason for rejecting a call. The default value is rejected . |
Reject Reasons
Response Code | Reject Reason | Description |
---|---|---|
busy |
600 Busy Everywhere | All possible destinations are busy. |
busy-here |
486 Busy Here | The destination is busy at the current location. |
decline |
603 Decline | The destination does not wish to participate in the call or cannot do so. |
does-not-exist |
604 Does Not Exist Anywhere | The server has authoritative information that the requested destination does not exist anywhere. |
forbidden /rejected |
403 Forbidden | The destination understood the request, but is refusing to fulfill it. |
not-found |
404 Not Found | The destination could not be found. |
redirect |
302 Moved Temporarily | The destination has been temporarily moved to another location. |
Say
In this example, a thank you message will be read twice to the caller because
loop
is set to2
. Between loops one and two, there will be a five second pause becauseloopPause
is set to5
.
<Response>
<Say voice="woman" loop="2" loopPause="5">Thank you for calling customer service</Say>
</Response>
Say
converts written text to voice. This is a verbal message that the caller will hear. Supported attributes can be added to customize the type of voice and the number of repetitions of the message.
Integers added into the Say
verb will be read according to how they are entered. “123” will be read as “one hundred twenty-three” and “1 2 3” will be read as “one two three”. To add a pause in the message, close out the Say
tag, insert a Pause
tag, and then open a new Say
tag with the rest of the text.
Supported Attributes
These attributes can be used to modify the Say
verb. They are inserted as name-value pairs in the start-tag.
Attribute | Data Type | Description |
---|---|---|
loop | integer | The amount of times that the message will play. Integers entered into this field must be greater than or equal to 0 . Enter 0 to play the message repeatedly until the call is ended. The maximum value accepted in this field is 100 . The default value is 1 . |
loopPause | integer | The number of seconds between each loop repetition. Integers entered into this field must be greater than or equal to 1 . The maximum value accepted in this field is 300 . The default value is 0 , meaning that there will be no pause between repetitions. |
voice | string | The type of voice that will read the text. Values accepted in this field are man and woman . The default value is man . |
Sms
In this example, an SMS message is sent to the phone number value of
to
. The message body is added between theSms
tags. If noto
andfrom
attributes are added to theSms
tag, the sending party will default to the calling party, and the receiving party will default to the called party.
<Response>
<Sms to="15162065317">Have a great day!</Sms>
</Response>
The Sms
verb sends an SMS message to a phone number during a phone call. Use the attributes to define the receiving and sending parties. If an action
attribute is added to the Sms
verb, all verbs remaining in the current FlexML instructions are ignored. If no action
is provided, the call flow will move to the next verb in the current FlexML instructions.
Supported Attributes
These attributes can be used to modify the Sms
verb. They are inserted as name-value pairs in the start-tag.
Attribute | Data Type | Description |
---|---|---|
action | string | The link to the set of FlexML instructions that will be requested after the Sms verb has been executed. |
from | string | The phone number that will send the message. The phone number must be in E.164 format. If no from value is added, this value will default to the phone number that the call is from. |
method | string | The type of request made to the action URL. Values accepted in this field are POST or GET . The default value is POST . |
to | string | The phone number that will receive the message. The phone number must be in E.164 format. If no to value is added, this value will default to the phone number that received the call. |
Wait
Wait
stops the next verb in the FlexML instructions from executing before the number of seconds has elapsed. The Wait
verb is the same as the Pause
verb. Please refer to the Pause section for more information.
FlexML Nouns
FlexML nouns are used to extend FlexML verbs. They are nested inside the verbs (e.g., Dial, Play) and allow the users to specify additional parameters.
File
Sample
Play
verb that uses theFile
noun together with thefile_sid
parameter to specify the playback file.
<Response>
<Play>
<File>d620ec24-acd8-4193-9249-b89f46ee3654</File>
</Play>
</Response>
The File
noun is nested inside the Play verb and use the file_sid
attribute of the File object. This attribute specifies the secure ID of the file, which will be played to the caller. It can be obtained using the Get Files request.
Using the secure ID instead of the link allows the partners store the files with CarrierX storage and link these files to their FlexML application without the need to set the complete path to the file.
Number
In this example, once the call is answered, the wait of two seconds will be performed (the total length of four
,
characters, each equal to 0.5-second delay), after that the1928
DTMF tones will be played to the dialed number.
<Response>
<Dial>
<Number sendDigits=",,,,1928">15162065340</Number>
</Dial>
</Response>
The Number
noun is nested inside the Dial verb. It contains the DID number to be dialed. It supports the following attributes:
Attribute | Data Type | Description |
---|---|---|
sendDigits | string | The DTMF tones that will be played when the call is answered. This is especially useful when dialing a phone number with an extension. Values accepted in this field are: 0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , # , * , , , and the combinations of these characters. Each comma character defines a 0.5-second delay. |
CarrierX allows dialing to several numbers at once using the Number
noun. Refer to the Simultaneous Ring to Several Numbers section of the Dial
verb for more information about this.
Query Arguments
In this example, two
X-
headers will be sent when dialing the phone number specified in theNumber
noun nested inside theDial
verb.
<Response>
<Dial>
<Number>15162065340?X-CustomHeader1=ABC&X-CustomHeader2=DEF</Number>
</Dial>
</Response>
The additional query arguments can be used to send custom headers inside the Number
noun. Use the ?
character after the phone number to add these headers. Several headers are joined with the &
character.
API Reference
The FlexML API has the following sections: Accounts, Calls, and DIDs.
- Use the Account object to modify call settings.
- Target the Call object to create, modify, and delete phone calls.
- The DID object holds modifiable data about phone numbers rented through CarrierX.
Accounts
Each FlexML Application Endpoint has its own Account object. The Account object holds the settings for that specific FlexML Application Endpoint. Changes made to the Account object will affect all of the calls associated with that particular account.
Account Object
This section outlines the Account object. The fields listed in the table below will be returned in a JSON object when a successful request has been made.
Sample Account object:
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"date_created": "2018-09-20T21:56:49.000Z",
"error_handler": "basic",
"login": "sample_flexml_984",
"method": "POST",
"name": "sample_flexml",
"url": null
}
Attribute | Data Type | Description |
---|---|---|
account_sid read only | string | The account secure ID. |
date_created read only | string | The date and time when the account was created. |
error_handler update | string | This is the way that is used to handle the errors. Values accepted in this field are basic and none . When the value is basic , a recording will play when an app error occurs. If the value is set to none , error handling will defer to the carrier settings. The default value is basic . |
login read only | string | The login username used to access the FlexML endpoint. Each endpoint has a unique login and password. |
method update | string | The HTTP method used to execute the request if no method is assigned in the DID object. This method can be set as either POST or GET . The default value is POST . |
name update | string | The account name. This is a human-readable nickname for the account. |
password read only | string | The password used to access the FlexML endpoint. Each endpoint has a unique login and password. The password field is hidden and not returned in the responses. |
url update | string | The URL where the FlexML instructions are located. To indicate the type of request sent to this URL, set the method field. |
Get Accounts
The following
GET
request returns accounts matching the criteria in the request URL.
curl -X GET \
'https://api.carrierx.com/flexml/v1/accounts?offset=0&limit=10&order=name' \
-u '[your_user_name]:[your_password]'
A successful request will return a
200
response code with a list of Account objects.
{
"count": 1,
"has_more": false,
"items": [
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"date_created": "2018-09-20T21:56:49.000Z",
"error_handler": "basic",
"login": "sample_flexml_984",
"method": "POST",
"name": "sample_flexml",
"url": null
}
],
"limit": 10,
"offset": 0,
"pagination": {},
"total": 1
}
This request shows accounts data for the currently logged-in partner.
GET | /accounts |
This request is enabled for Pagination, Result Filtering, and Field Filtering.
Get Account by SID
The following
GET
request returns an account, targeted by secure ID.
curl -X GET \
'https://api.carrierx.com/flexml/v1/accounts/e4d82fab-b613-4c0d-bd40-a9f94e8263c7' \
-u '[your_user_name]:[your_password]'
A successful request will return a
200
response code with a serialized copy of the Account object.
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"date_created": "2018-09-20T21:56:49.000Z",
"error_handler": "basic",
"login": "sample_flexml_984",
"method": "POST",
"name": "sample_flexml",
"url": null
}
This request will return data for an account, targeted by secure ID.
GET | /accounts/{account_sid} |
This request is enabled for Field Filtering.
Path Arguments
Parameter | Data Type | Description |
---|---|---|
account_sid required |
string | The account secure ID. |
Update Account
The following
PATCH
request updates the Account object, targeted by secure ID, with the values in the request body.
curl -X PATCH \
'https://api.carrierx.com/flexml/v1/accounts/592210fa-8126-4255-bc77-c8dedb6af834' \
-H 'Content-Type: application/json' \
--data-binary '{"method":"POST", "error_handler": "none"}' \
-u '[your_user_name]:[your_password]'
A successful request will return a
200
response code with a serialized copy of the updated Account object.
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"date_created": "2018-09-20T21:56:49.000Z",
"error_handler": "none",
"login": "sample_flexml_984",
"method": "POST",
"name": "sample_flexml",
"url": null
}
This request updates an account, targeted by secure ID.
PATCH | /accounts/{account_sid} |
PUT | /accounts/{account_sid} |
An Account object can be updated using either a PATCH
or PUT
request.
-
A
PATCH
request can be used to update one or more attribute values. When using aPATCH
request, only the attributes specified in the request payload will be updated, all other attributes and values will remain the same. The account secure ID is passed in the query URL, and the values to be modified are passed in the request body. -
A
PUT
request can be used to update an entire Account object. The account secure ID is passed in the query URL, and the entire Account object is passed in the request body.
Path Arguments
Parameter | Data Type | Description |
---|---|---|
account_sid required |
string | The account secure ID. |
Body Arguments
JSON representation of the fields and values to be updated.
Fields that can be modified are:
error_handler
method
name
url
Refer to this table to view all fields that appear in the Account object.
Calls
Calls occur when the CarrierX system dials out to a phone number. FlexML instructions are added to the call flow by setting the url
parameter.
Call Object
This section goes over the parts of the Call object. These fields and values make up the JSON response that gets returned when a request is successful. In this section, there is also information about the optional fields that can be added to further customize calls. These fields can be added when initially creating the binding, or they can be added later using PATCH
or PUT
requests.
Sample Call object:
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"attributes": {},
"call_sid": "2f367eb5-adc6-4413-b603-533e2a8f0804",
"called_did": "15162065317",
"calling_did": "15162065319",
"date_created": "2018-10-16T20:59:18.094Z",
"delay": 0,
"method": "POST",
"status_callback_method": "POST",
"status_callback_url": null,
"url": null
}
Attribute | Data Type | Description |
---|---|---|
account_sid read only | string | The secure ID of the account to which the call belongs. |
attributes create update | object | Additional attributes that can be used to further customize a call. See the table below for built-in attributes. Custom attributes can also be added to this parameter as key-value pairs. |
call_sid read only | string | The call secure ID. |
called_did create update | string | The call destination phone number. This phone number will appear in E.164 format. |
calling_did create update | string | The DID that initiates the call. This DID will appear in E.164 format. |
date_created read only | string | The date and time when the Call object was created. |
delay create update | integer | The number of seconds before the call will execute. The default value is 0 , meaning that the call will execute immediately. |
method create update | string | The HTTP method used to execute the request. This method can be set as either POST or GET . The default value is POST . |
status_callback_method create update | string | The HTTP method used to execute the request to the status_callback_url . The default value is POST . |
status_callback_url create update | string | The URL that stores the call data, which can be heard at the end of a call. Set the way that this URL is queried by assigning the status_callback_method value. |
url create update | string | The URL with the FlexML instructions. The request type used to query this URL is the value of method . |
Attribute Object
The following are attributes that can be added to the Call object.
Attribute | Data Type | Description |
---|---|---|
cnam create update | string | The CNAM for outbound calls. Note that this may not be preserved for calls terminated through the PSTN. |
sip_header_* create update | string | The values in this field will be sent as extra SIP headers, added to the SIP invite. The header name must start with X- . |
Create Call
The following
POST
request creates a call.
curl -X POST \
'https://api.carrierx.com/flexml/v1/calls' \
-H 'Content-Type: application/json' \
--data-binary '{"calling_did":"15162065319", "called_did":"15162065318"}' \
-u '[your_user_name]:[your_password]'
A successful request will return a
200
response code with a serialized copy of the Call object.
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"attributes": {},
"call_sid": "2f367eb5-adc6-4413-b603-533e2a8f0804",
"called_did": "15162065317",
"calling_did": "15162065319",
"date_created": "2018-10-16T20:59:18.094Z",
"delay": 0,
"method": "POST",
"status_callback_method": "POST",
"status_callback_url": null,
"url": null
}
This request creates a call.
POST | /calls |
Body Arguments
JSON representation of the fields and values of the Call object to be created.
Required fields to create a call are:
called_did
calling_did
The calling_did
should be one of the DIDs assigned to the FlexML endpoint.
To schedule a call to happen in the future, set the delay
parameter to the amount of seconds to wait before the call is executed.
Refer to this table to view all fields that appear in the Call object.
Get Calls
The following
GET
request returns calls matching the criteria in the request URL.
curl -X GET \
"https://api.carrierx.com/flexml/v1/calls?offset=0&limit=10" \
-u '[your_user_name]:[your_password]'
A successful request will return a
200
response code with a list of Call objects.
{
"count": 1,
"has_more": false,
"items": [
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"attributes": {},
"call_sid": "9dc690bb-a627-4af6-95be-0e259250d8df",
"called_did": "15162065317",
"calling_did": "15162065319",
"date_created": "2018-10-16T21:56:49.000Z",
"delay": 9993,
"method": "POST",
"status_callback_method": "POST",
"status_callback_url": null,
"url": null
}
],
"limit": 10,
"offset": 0,
"pagination": {},
"total": 1
}
This request will return a list of Call objects scheduled for some time in the future.
GET | /calls |
All Call objects that are returned will have a delay
parameter of more than 0
. By default, the delay
parameter is set to 0
, so calls will be executed immediately after they are created.
This request is enabled for Pagination, Result Filtering, and Field Filtering.
Get Call by SID
The following
GET
request returns a call, targeted by secure ID.
curl -X GET \
'https://api.carrierx.com/flexml/v1/calls/9dc690bb-a627-4af6-95be-0e259250d8df' \
-u '[your_user_name]:[your_password]'
A successful request will return a
200
response code with a serialized copy of the Call object.
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"attributes": {},
"call_sid": "9dc690bb-a627-4af6-95be-0e259250d8df",
"called_did": "15162065317",
"calling_did": "15162065319",
"date_created": "2018-10-16T21:56:49.000Z",
"delay": 9916,
"method": "POST",
"status_callback_method": "POST",
"status_callback_url": null,
"url": null
}
This request returns data for a call, targeted by secure ID.
GET | /calls/{call_sid} |
The call_sid
must be passed in the path arguments.
This request is enabled for Field Filtering.
Path Arguments
Parameter | Data Type | Description |
---|---|---|
call_sid required |
string | The call secure ID. |
Update Call
The following
PATCH
request updates the Call object, targeted by secure ID, with the values in the request body.
curl -X PATCH \
'https://api.carrierx.com/flexml/v1/calls/9dc690bb-a627-4af6-95be-0e259250d8df' \
-H 'Content-Type: application/json' \
--data-binary '{"delay": 1000}' \
-u '[your_user_name]:[your_password]'
A successful request will return a
200
response code with a serialized copy of the updated Call object.
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"attributes": {},
"call_sid": "9dc690bb-a627-4af6-95be-0e259250d8df",
"called_did": "15162065317",
"calling_did": "15162065319",
"date_created": "2018-10-16T21:56:49.000Z",
"delay": 1000,
"method": "POST",
"status_callback_method": "POST",
"status_callback_url": null,
"url": null
}
This request updates a call, targeted by secure ID.
PATCH | /calls/{call_sid} |
PUT | /calls/{call_sid} |
A Call object can be updated using either a PATCH
or PUT
request.
-
A
PATCH
request can be used to update one or more attribute values. When using aPATCH
request, only the attributes specified in the request payload will be updated, all other attributes and values will remain the same. The call secure ID is passed in the query URL, and the values to be modified are passed in the request body. -
A
PUT
request can be used to update an entire Call object. The call secure ID is passed in the query URL, and the entire Call object is passed in the request body.
Path Arguments
Parameter | Data Type | Description |
---|---|---|
call_sid required |
string | The call secure ID. |
Body Arguments
JSON representation of the fields and values to be updated.
Fields that can be modified are:
attributes
called_did
calling_did
delay
method
status_callback_method
status_callback_url
url
Refer to this table to view all fields that appear in the Call object.
Delete Call
The following
DELETE
request deletes a call, targeted by secure ID.
curl -X DELETE \
'https://api.carrierx.com/flexml/v1/calls/9dc690bb-a627-4af6-95be-0e259250d8df' \
-u '[your_user_name]:[your_password]'
A successful request will return a
204
response code with an empty body.
This request deletes a call, targeted by secure ID.
DELETE | /calls/{call_sid} |
Path Arguments
Parameter | Data Type | Description |
---|---|---|
call_sid required |
string | The call secure ID. |
DIDs
DIDs are phone numbers rented through CarrierX. They serve as calling_did
values.
DID Object
This section describes the fields of the DID object. These fields and values are returned as the JSON object that gets returned with successful requests.
Sample DID object:
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"country_code": "USA",
"did_sid": "d72c0ec3-c21d-4db1-8877-690cb9644fbc",
"in_country_format": "(516) 206-5319",
"international_format": "+1 516-206-5319",
"method": "POST",
"phonenumber": "15162065319",
"status_callback_method": "POST",
"status_callback_url": null,
"url": null
}
Attribute | Data Type | Description |
---|---|---|
account_sid read only | string | The secure ID of the account to which the DID belongs. |
country_code read only | string | The ISO 3166-1 alpha-3 code of the DID. |
did_sid read only | string | The DID secure ID. |
in_country_format read only | string | The DID in national format. |
international_format read only | string | The DID in international format. |
method update | string | The HTTP method used to execute the request. Values accepted in this field are POST or GET . The default value is POST . |
phonenumber read only | string | The phone number for the DID in E.164 format without the + prefix. |
status_callback_method update | string | The method used to request status_callback_url . Values accepted in this field are POST or GET . The default value is POST . |
status_callback_url update | string | If a URL is provided in this field, there will be a message at the end of calls involving this DID that provides information about the call. Assign this URL to obtain call length, etc. |
url update | string | The URL where the instructions are located. If the url is not defined for a specific DID, the url from the Account object will be used. |
Get DIDs
The following
GET
request returns DIDs matching the criteria in the request URL.
curl -X GET \
'https://api.carrierx.com/flexml/v1/dids' \
-u '[your_user_name]:[your_password]'
A successful request will return a
200
response code with a list of DID objects associated with the endpoint.
{
"count": 1,
"has_more": false,
"items": [
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"country_code": "USA",
"did_sid": "d72c0ec3-c21d-4db1-8877-690cb9644fbc",
"in_country_format": "(516) 206-5319",
"international_format": "+1 516-206-5319",
"method": "POST",
"phonenumber": "15162065319",
"status_callback_method": "POST",
"status_callback_url": null,
"url": null
}
],
"limit": 10,
"offset": 0,
"pagination": {},
"total": 1
}
This request returns a list of DIDs associated with a FlexML Application Endpoint.
GET | /dids |
This request is enabled for Pagination, Result Filtering, and Field Filtering.
Get DID by SID
The following
GET
request returns a DID object, targeted by secure ID.
curl -X GET \
'https://api.carrierx.com/flexml/v1/dids/d72c0ec3-c21d-4db1-8877-690cb9644fbc' \
-u '[your_user_name]:[your_password]'
A successful request will return a
200
response code with a serialized copy of the DID object.
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"country_code": "USA",
"did_sid": "d72c0ec3-c21d-4db1-8877-690cb9644fbc",
"in_country_format": "(516) 206-5319",
"international_format": "+1 516-206-5319",
"method": "POST",
"phonenumber": "15162065319",
"status_callback_method": "POST",
"status_callback_url": null,
"url": null
}
This request returns data for a DID, targeted by secure ID.
GET | /dids/{did_sid} |
This request is enabled for Field Filtering.
Path Arguments
Parameter | Data Type | Description |
---|---|---|
did_sid required |
string | The DID secure ID. |
Update DID
The following
PATCH
request updates the DID object, targeted by secure ID, with the values in the request body.
curl -X PATCH \
'https://api.carrierx.com/flexml/v1/dids/d72c0ec3-c21d-4db1-8877-690cb9644fbc' \
-H 'Content-Type: application/json' \
--data-binary '{"method":"GET"}' \
-u '[your_user_name]:[your_password]'
A successful request will return a
200
response code with a serialized copy of the updated DID object.
{
"account_sid": "1d4adc32-45d1-4789-9780-928049e2bce1",
"country_code": "USA",
"did_sid": "d72c0ec3-c21d-4db1-8877-690cb9644fbc",
"in_country_format": "(516) 206-5319",
"international_format": "+1 516-206-5319",
"method": "GET",
"phonenumber": "15162065319",
"status_callback_method": "POST",
"status_callback_url": null,
"url": null
}
This request updates a DID, targeted by secure ID.
PATCH | /dids/{did_sid} |
PUT | /dids/{did_sid} |
A DID object can be updated using either a PATCH
or PUT
request.
-
A
PATCH
request can be used to update one or more attribute values. When using aPATCH
request, only the attributes specified in the request payload will be updated, all other attributes and values will remain the same. The DID secure ID is passed in the query URL, and the values to be modified are passed in the request body. -
A
PUT
request can be used to update an entire DID object. The DID secure ID is passed in the query URL, and the entire DID object is passed in the request body.
Path Arguments
Parameter | Data Type | Description |
---|---|---|
did_sid required |
string | The DID secure ID. |
Body Arguments
JSON representation of the fields and values to be updated.
Fields that can be modified are:
method
status_callback_method
status_callback_url
url
Refer to this table to view all fields that appear in the DID object.