curl -X GET \
'https://api.carrierx.com/core/v2/endpoints' \
-u '[your_user_name]:[your_password]'

https://api.carrierx.com/core/v2

Pagination

The four optional parameters for pagination are: offset , limit , order , and filter . These parameters are added to the query URL of GET requests. They inform 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 . Enter the field name to be ordered followed by the order value, either asc or desc . For example, name desc will return records sorted by name in reverse-alphabetical order. Since the default is asc , entering name by itself 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 the pagination field.

Parameters and values for pagination are added to the query URL.

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/mediator/v1/bindings?offset=2&limit=4' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
  "body": {
      "count": 0,
      "has_more": false,
      "items": [],
      "limit": 4,
      "offset": 2,
      "pagination": {
          "previous": "https://api.carrierx.com/mediator/v1/accounts?limit=4&offset=0"
      },
      "total": 1
  },
  "status": 200
}

Pagination Quick Reference

The parameter filter is used to restrict or customize the JSON response. Operators can be combined for more specific searches, and are added to the query URL.

Relational Operator Quick Reference

Field Filtering

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 Reference 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.

Parameters and values for field filtering are added to the query URL.

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/mediator/v1/bindings?exclude_fields="name"' \
-u '[your_user_name]:[your_password]'

Field Filtering Quick Reference

Look Up Effective ACLs for Calls

curl -X GET \
'https://api.carrierx.com/core/v2/accesscontrol/effective_acl/calls' \
-u '[your_user_name]:[your_password]'

Look Up Effective ACLs for SMS

curl -X GET \
'https://api.carrierx.com/core/v2/accesscontrol/effective_acl/sms' \
-u '[your_user_name]:[your_password]'

Create Access Control Rule

curl -X POST \
'https://api.carrierx.com/core/v2/accesscontrol/rules' \
-H 'Content-Type: application/json' \
--data-binary '{"field":"to", "quantifier":"any", "operation":"prefix","entries": ["1800","1615"]}' \
-u '[your_user_name]:[your_password]'

Get Access Control Rules Matching the Specified Criteria

curl -X GET \
'https://api.carrierx.com/core/v2/accesscontrol/rules?offset=0&limit=1' \
-u '[your_user_name]:[your_password]'

curl -X GET \
'https://api.carrierx.com/core/v2/accesscontrol/rules/dafd993d-0e99-4af9-b8fc-436fb01b0bbe' \
-u '[your_user_name]:[your_password]'

Update Access Control Rule

curl -X PATCH \
'https://api.carrierx.com/core/v2/accesscontrol/rules/c9109b54-13f2-4157-ba23-2984b3a207dc' \
-H 'Content-Type: application/json' \
--data-binary '{"operation":"exact"}' \
-u '[your_user_name]:[your_password]'

curl -X PUT \
'https://api.carrierx.com/core/v2/accesscontrol/rules/c9109b54-13f2-4157-ba23-2984b3a207dc' \
-H 'Content-Type: application/json' \
--data-binary '{"entries": ["1800","1615"], "field": "to", "name": "new_name", "operation": "exact", "quantifier": "any", "read_only": false, "rule_sid": "c9109b54-13f2-4157-ba23-2984b3a207dc"}' \
-u '[your_user_name]:[your_password]'

Delete Access Control Rule

curl -X DELETE \
'https://api.carrierx.com/core/v2/accesscontrol/rules/c9109b54-13f2-4157-ba23-2984b3a207dc' \
-u '[your_user_name]:[your_password]'

Get Call Detail Records Matching the Specified Criteria

curl -X GET \
'https://api.carrierx.com/core/v2/calls/call_drs' \
-u '[your_user_name]:[your_password]'

Get Call Detail Record by SID

curl -X GET \
'https://api.carrierx.com/core/v2/calls/call_drs/c02a73b2-8401-459a-af7e-f4cc3eee7854' \
-u '[your_user_name]:[your_password]'

Rate Object Reference

Get Inbound Rates Matching the Specified Criteria

curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/inbound?limit=1' \
-u '[your_user_name]:[your_password]'

{
    "active": "yes",
    "count": 1,
    "effective_date": "2017-10-03T00:00:00.000Z",
    "has_more": true,
    "items": [
        {
            "billing_increment": "60",
            "billing_minimum": "60",
            "country_code": null,
            "country_name": null,
            "prefix": null,
            "price": "0.0025"
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {
        "next": "https://api.carrierx.com/core/v2/calls/rates/inbound?limit=1&offset=1"
    },
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "rates_plan": {
        "name": "voice_inbound_rates-2017-10-15",
        "rates_plan_sid": "6ad7df5d-7603-4d1b-8f5e-223b7dee0c6d"
    },
    "total": 9
}

Download CSV with Inbound Rates Matching the Specified Criteria

curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/inbound/csv' \
-u '[your_user_name]:[your_password]'

Get Outbound Rates Matching the Specified Criteria

curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/outbound?limit=1' \
-u '[your_user_name]:[your_password]'

{
    "active": "yes",
    "count": 1,
    "effective_date": "2017-10-30T00:00:00.000Z",
    "has_more": true,
    "items": [
        {
            "billing_increment": "60",
            "billing_minimum": "60",
            "country_code": "USA",
            "country_name": "United States",
            "prefix": "1201200",
            "price": "0.01"
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {
        "next": "https://api.carrierx.com/core/v2/calls/rates/outbound?limit=1&offset=1"
    },
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "rates_plan": {
        "name": "voice_customer_rates-2017-10-05",
        "rates_plan_sid": "0428d20f-7869-4cf5-aa5c-f44f99a19515"
    },
    "total": 111857
}

Download CSV with Inbound Rates Matching the Specified Criteria

curl -X GET \
'https://api.carrierx.com/core/v2/calls/rates/outbound/csv' \
-u '[your_user_name]:[your_password]'

Get Countries

curl -X GET \
'https://api.carrierx.com/core/v2/countries?limit=1' \
-u '[your_user_name]:[your_password]'

Get Country by ISO code

curl -X GET \
'https://api.carrierx.com/core/v2/countries/ITA?exclude_fields=common_name' \
-u '[your_user_name]:[your_password]'

Get Country by IP address

curl -X GET \
'https://api.carrierx.com/core/v2/countries/ip/2.6.26.2' \
-u '[your_user_name]:[your_password]'

Create Endpoint

curl -X POST \
'https://api.carrierx.com/core/v2/endpoints' \
-H 'Content-Type: application/json' \
--data-binary '{"name":"my_conf", "type":"conference"}' \
-u '[your_user_name]:[your_password]'

curl -X POST \
'https://api.carrierx.com/core/v2/endpoints' \
-H 'Content-Type: application/json' \
--data-binary '{"name":"EP_Т_1","addresses": ["ip": "1.1.2.13", "port": "5060"], "type":"third_party"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response: Third Party

{
    "addresses": [
        {
            "direction": "any",
            "ip": "1.1.2.13",
            "port": 5060,
            "transport": "udp"
        }
    ],
    "attributes": {},
    "capacity": 0,
    "endpoint_sid": "473d1623-c615-4b43-ab4f-01cd5491c56b",
    "name": "my_third_party",
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "properties": {},
    "transformations": [],
    "type": "third_party",
    "voip_token": "0cac0ffe-fed4-4ee3-8212-e50659e28088"
}

Get Endpoints Matching the Specified Criteria

curl -X GET \
'https://api.carrierx.com/core/v2/endpoints?filter=addresses.ip+eq+"1.1.2.13"' \
-u '[your_user_name]:[your_password]'

Get Endpoint by SID

This request returns information about an endpoint, targeted by secure ID.

curl -X GET \
'https://api.carrierx.com/core/v2/endpoints/473d1623-c615-4b43-ab4f-01cd5491c56b' \
-u '[your_user_name]:[your_password]'

Update Endpoint

An endpoint can be updated using PATCH and PUT requests. A PATCH request can be used to update one or more attribute values. When using a PATCH request, only the attributes specified in the request will be updated. All other attributes and values will remain the same. The endpoint secure ID is passed in the query URL, and the parameters are passed in the request body.

Path Arguments

Sample Curl Command

curl -X PATCH \
'https://api.carrierx.com/core/v2/endpoints/00bf8b25-1e20-4f80-8529-8448df32d71a' \
-H 'Content-Type: application/json' \
--data-binary '{"name":"my_third_party_ep"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "addresses": [
        {
            "direction": "any",
            "ip": "1.1.2.13",
            "port": 5060,
            "transport": "udp"
        }
    ],
    "attributes": {},
    "capacity": 0,
    "endpoint_sid": "1a34c5e9-3a09-4de5-b553-5f6a9ef202ac",
    "name": "my_third_party_ep",
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "properties": {},
    "transformations": [],
    "type": "third_party",
    "voip_token": "2c95517b-a5e8-4415-b471-cdd81d5a6dcb"
}

A successful request will return a 200 response code with a serialized copy of the Endpoint object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

A PUT request can be used to update the entire Endpoint object. This request can be used to remove, add, and modify values. The endpoint secure ID is passed in the query URL and the entire Endpoint object is passed in the request body.

Path Arguments

Sample Curl Command

curl -X PUT \
'https://api.carrierx.com/core/v2/endpoints/1a34c5e9-3a09-4de5-b553-5f6a9ef202ac' \
-H 'Content-Type: application/json' \
--data-binary '{"addresses": [{"direction": "any", "ip": "1.1.2.13", "port": 5060, "transport": "udp"}],"attributes": {}, "capacity": 100, "endpoint_sid": "1a34c5e9-3a09-4de5-b553-5f6a9ef202ac", "name": "my_third_party_ep", "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0", "properties": {}, "transformations": [], "type": "third_party", "voip_token": "2c95517b-a5e8-4415-b471-cdd81d5a6dcb"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "addresses": [
        {
            "direction": "any",
            "ip": "1.1.2.13",
            "port": 5060,
            "transport": "udp"
        }
    ],
    "attributes": {},
    "capacity": 100,
    "endpoint_sid": "1a34c5e9-3a09-4de5-b553-5f6a9ef202ac",
    "name": "my_third_party_ep",
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "properties": {},
    "transformations": [],
    "type": "third_party",
    "voip_token": "2c95517b-a5e8-4415-b471-cdd81d5a6dcb"
}

A successful request will return a 200 response code with a serialized copy of the Endpoint object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

This request deletes an endpoint from a partner account. Note that the System Gateway endpoint, which is automatically generated when a new partner is created, should not be deleted.

Path Arguments

Sample Curl Command

curl -X DELETE \
'https://api.carrierx.com/core/v2/endpoints/1a34c5e9-3a09-4de5-b553-5f6a9ef202ac' \
-u '[your_user_name]:[your_password]'

A successful request will return a 204 response code with an empty body. Refer to the HTTP Status Codes section for a comprehensive list of errors.

Invoices

An Invoice object is automatically created when a new partner is added to the system. One invoice exists for each partner, and is updated when new charges occur.

Invoice Object Reference

This section describes the elements of the Invoice object. These fields and values make up the JSON object that gets returned with successful requests.

items

pay_items

This request returns a list of invoices. This request is enabled for Pagination and Field Filtering. Refer to the Using the REST API section for more information.

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/invoices?limit=1' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "count": 1,
    "has_more": true,
    "items": [
        {
            "amount": "0.38",
            "amount_due": "0",
            "amount_tax": "0",
            "balance_previous": "-351.91",
            "date_billing_period_end": "2019-01-19T23:59:59.000Z",
            "date_billing_period_start": "2018-12-20T00:00:00.000Z",
            "date_charge_expected": "2019-01-19T23:59:59.000Z",
            "date_charged": null,
            "date_created": "2018-12-19T23:30:01.000Z",
            "date_issued": null,
            "display_id": "004",
            "invoice_items": [
                {
                    "amount": "0.37",
                    "date_billing_period_end": "2019-01-19T23:59:59.000Z",
                    "date_billing_period_start": "2018-12-20T00:00:00.000Z",
                    "direction": "inbound",
                    "type": "toll",
                    "usage": 8880
                },
                {
                    "amount": "0.01",
                    "country_code": "USA",
                    "date_billing_period_end": "2019-01-19T23:59:59.000Z",
                    "date_billing_period_start": "2018-12-20T00:00:00.000Z",
                    "direction": "outbound",
                    "type": "toll",
                    "usage": 60
                }
            ],
            "invoice_sid": "4169705e-4284-482f-8e72-e962a8aaad9d",
            "paid": false,
            "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
            "pay_items": [],
            "status": "open",
            "tax_items": []
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {
        "next": "https://api.carrierx.com/core/v2/invoices?limit=1&offset=1"
    },
    "total": 4
}

A successful request will return a 200 response code with a serialized copy of the Invoice object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

This request returns data for an invoice, targeted by secure ID. This request is enabled for Field Filtering .

Path Arguments

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/invoices/4169705e-4284-482f-8e72-e962a8aaad9d' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "amount": "0.38",
    "amount_due": "0",
    "amount_tax": "0",
    "balance_previous": "-351.91",
    "date_billing_period_end": "2019-01-19T23:59:59.000Z",
    "date_billing_period_start": "2018-12-20T00:00:00.000Z",
    "date_charge_expected": "2019-01-19T23:59:59.000Z",
    "date_charged": null,
    "date_created": "2018-12-19T23:30:01.000Z",
    "date_issued": null,
    "display_id": "004",
    "invoice_items": [
        {
            "amount": "0.37",
            "date_billing_period_end": "2019-01-19T23:59:59.000Z",
            "date_billing_period_start": "2018-12-20T00:00:00.000Z",
            "direction": "inbound",
            "type": "toll",
            "usage": 8880
        },
        {
            "amount": "0.01",
            "country_code": "USA",
            "date_billing_period_end": "2019-01-19T23:59:59.000Z",
            "date_billing_period_start": "2018-12-20T00:00:00.000Z",
            "direction": "outbound",
            "type": "toll",
            "usage": 60
        }
    ],
    "invoice_sid": "4169705e-4284-482f-8e72-e962a8aaad9d",
    "paid": false,
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "pay_items": [],
    "status": "open",
    "tax_items": []
}

A successful request will return a 200 response code with a serialized copy of the Invoice object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

This request returns data for a particular invoice in HTML format. If the request succeeds, there will be a download link.

Path Arguments

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/invoices/6765ca8a-91c7-4241-98c6-42803de77e74.html' \
-u '[your_user_name]:[your_password]'

This request returns a 200 status code with successful requests, alongside an invoice in HTML format. For common errors that get returned, refer to the HTTP Status Codes section.

This request returns data for the specified phone number. This request is enabled for Field Filtering .

Path Arguments

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/lookup/dids/15162065319?cnam=true&lrn=true&carrier=true' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "country_code": "USA",
    "details": {
        "carrier": {
            "mcc": null,
            "mnc": null,
            "name": null,
            "type": null
        },
        "cnam": {
            "name": "",
            "type": null
        },
        "lrn": "6466531111"
    },
    "e164_format": "+15162065319",
    "in_country_format": "(516) 206-5319",
    "international_format": "+1 516-206-5319",
    "phonenumber": "15162065319",
    "state": "NY"
}

Response Object

carrier

cnam

details

Revoke Current OAuth Token

curl -X POST \
'https://api.carrierx.com/core/v2/oauth/logout' \
-H 'Content-Type: application/json' \
-u '[your_user_name]:[your_password]'

Revoke OAuth Token

curl -X POST \
'https://api.carrierx.com/core/v2/oauth/revoke/' \
-H 'Content-Type: application/json' \
-u '[your_user_name]:[your_password]'

Get OAuth Bearer Token

curl -X POST \
'https://api.carrierx.com/core/v2/oauth/token?grant_type=password&client_id=carrierx&client_secret=50339091-14fe-442c-bbcb-83b674dbf90c&username=carrierx_test&password=carrierx_test_pwd&scope=trust' \
-H 'Content-Type: application/json' \
-u '[your_user_name]:[your_password]'

Get All Active OAuth Bearer Tokens for the Partner

curl -X GET \
'https://api.carrierx.com/core/v2/oauth/tokens' \
-u '[your_user_name]:[your_password]'

Get Current Partner

curl -X GET \
'https://api.carrierx.com/core/v2/oauth/whoami' \
-u '[your_user_name]:[your_password]'

curl -X GET \
'https://api.carrierx.com/core/v2/partners' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "acls": [],
            "address1": null,
            "address2": null,
            "attributes": {},
            "balance": "351.52",
            "billing_email": "jsmith@freeconferencecall.com",
            "callbacks": {},
            "charge_at": "20",
            "city": null,
            "company_name": "CarrierX",
            "country_code": "USA",
            "date_created": "2018-09-20T21:34:55.000Z",
            "display_id": "CX72521509",
            "login": "johnsmith",
            "name": "John Smith",
            "owner_email": "jsmith@freeconferencecall.com",
            "parent_assigned_acls": [
                {
                    "access_control_rules": [
                        "93525bae-f9a9-446b-b92a-7f421df7a11e"
                    ],
                    "direction": "outbound",
                    "sms_action_false": null,
                    "sms_action_true": "accept",
                    "voice_action_false": null,
                    "voice_action_true": null
                }
            ],
            "parent_sid": "ac38616e-d2e7-4cd6-99ae-b6658f0728b6",
            "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
            "payment_type": "prepay",
            "phonenumber": "15162065819",
            "prepay_amount": "100",
            "spending_limit": "0",
            "state": null,
            "status": "active",
            "tech_email": "jsmith@freeconferencecall.com",
            "transformations": [],
            "zip": "90804"
        }
    ],
    "limit": 1000,
    "offset": 0,
    "pagination": {},
    "total": 1
}

curl -X GET \
'https://api.carrierx.com/core/v2/partners/ed437757-002d-4ecc-aa5a-efdf5e50dba0' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "acls": [],
    "address1": null,
    "address2": null,
    "attributes": {},
    "balance": "351.52",
    "billing_email": "jsmith@freeconferencecall.com",
    "callbacks": {},
    "charge_at": "20",
    "city": null,
    "company_name": "CarrierX",
    "country_code": "USA",
    "date_created": "2018-09-20T21:34:55.000Z",
    "display_id": "CX72521509",
    "login": "johnsmith",
    "name": "John Smith",
    "owner_email": "jsmith@freeconferencecall.com",
    "parent_assigned_acls": [
        {
            "access_control_rules": [
                "93525bae-f9a9-446b-b92a-7f421df7a11e"
            ],
            "direction": "outbound",
            "sms_action_false": null,
            "sms_action_true": "accept",
            "voice_action_false": null,
            "voice_action_true": null
        }
    ],
    "parent_sid": "ac38616e-d2e7-4cd6-99ae-b6658f0728b6",
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "payment_type": "prepay",
    "phonenumber": "15162065819",
    "prepay_amount": "100",
    "spending_limit": "0",
    "state": null,
    "status": "active",
    "tech_email": "jsmith@freeconferencecall.com",
    "transformations": [],
    "zip": "90804"
}

A successful request will return a 200 response code with a serialized copy of the Partner object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Update Partner

A partner can be updated using PATCH and PUT requests. A PATCH request can be used to update one or more attribute values. When using a PATCH request, only the attributes specified in the request will be updated. All other attributes and values will remain the same. The partner secure ID is passed in the query URL, and the parameters are passed in the request body. This request can be used to update the partner password, partner address, and add or remove acls and transformations .

Path Arguments

Body Arguments

Sample Curl Command

curl -X PATCH \
'https://api.carrierx.com/core/v2/partners/ed437757-002d-4ecc-aa5a-efdf5e50dba0' \
-H 'Content-Type: application/json' \
–-data-binary '{"address1":"4300 E Pacific Coast Hwy"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "acls": [],
    "address1": "4300 E Pacific Coast Hwy",
    "address2": null,
    "attributes": {},
    "balance": "351.52",
    "billing_email": "jsmith@freeconferencecall.com",
    "callbacks": {},
    "charge_at": "20",
    "city": null,
    "company_name": "CarrierX",
    "country_code": "USA",
    "date_created": "2018-09-20T21:34:55.000Z",
    "display_id": "CX72521509",
    "login": "johnsmith",
    "name": "John Smith",
    "owner_email": "jsmith@freeconferencecall.com",
    "parent_assigned_acls": [
        {
            "access_control_rules": [
                "93525bae-f9a9-446b-b92a-7f421df7a11e"
            ],
            "direction": "outbound",
            "sms_action_false": null,
            "sms_action_true": "accept",
            "voice_action_false": null,
            "voice_action_true": null
        }
    ],
    "parent_sid": "ac38616e-d2e7-4cd6-99ae-b6658f0728b6",
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "payment_type": "prepay",
    "phonenumber": "15162065574",
    "prepay_amount": "100",
    "spending_limit": "0",
    "state": null,
    "status": "active",
    "tech_email": "jsmith@freeconferencecall.com",
    "transformations": [],
    "zip": "90804"
}

A successful request will return a 200 response code with a serialized copy of the Partner object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

A PUT request can be used to update the entire Partner object. This request can be used to remove, add, and modify values. The partner secure ID is passed in the query ID and the body parameters and values are passed in the request body.

Path Arguments

Body Arguments

Sample Curl Command

curl -X PUT \
'https://api.carrierx.com/core/v2/partners/ed437757-002d-4ecc-aa5a-efdf5e50dba0' \
-H 'Content-Type: application/json' \
--data-binary '{"acls": [], "address1": "4300 E Pacific Coast Hwy", "address2": "Suite 1", "attributes": {}, "balance": "351.52", "billing_email": "jsmith@freeconferencecall.com", "callbacks": {}, "charge_at": "20", "city": null, "company_name": "CarrierX", "country_code": "USA", "date_created": "2018-09-20T21:34:55.000Z", "display_id": "CX72521509", "login": "johnsmith", "name": "John Smith", "owner_email": "jsmith@freeconferencecall.com", "parent_assigned_acls": [{"access_control_rules": ["93525bae-f9a9-446b-b92a-7f421df7a11e"],"direction": "outbound", "sms_action_false": null, "sms_action_true": "accept", "voice_action_false": null, "voice_action_true": null}], "parent_sid": "ac38616e-d2e7-4cd6-99ae-b6658f0728b6", "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0", "payment_type": "prepay", "phonenumber": "8057224756", "prepay_amount": "100", "spending_limit": "0", "state": null, "status": "active", "tech_email": "jsmith@freeconferencecall.com", "transformations": [], "zip": "90804" }' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "acls": [],
    "address1": "4300 E Pacific Coast Hwy",
    "address2": "Suite 1",
    "attributes": {},
    "balance": "351.52",
    "billing_email": "jsmith@freeconferencecall.com",
    "callbacks": {},
    "charge_at": "20",
    "city": null,
    "company_name": "CarrierX",
    "country_code": "USA",
    "date_created": "2018-09-20T21:34:55.000Z",
    "display_id": "CX72521509",
    "login": "johnsmith",
    "name": "John Smith",
    "owner_email": "jsmith@freeconferencecall.com",
    "parent_assigned_acls": [
        {
            "access_control_rules": [
                "93525bae-f9a9-446b-b92a-7f421df7a11e"
            ],
            "direction": "outbound",
            "sms_action_false": null,
            "sms_action_true": "accept",
            "voice_action_false": null,
            "voice_action_true": null
        }
    ],
    "parent_sid": "ac38616e-d2e7-4cd6-99ae-b6658f0728b6",
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "payment_type": "prepay",
    "phonenumber": "15162065574",
    "prepay_amount": "100",
    "spending_limit": "0",
    "state": null,
    "status": "active",
    "tech_email": "jsmith@freeconferencecall.com",
    "transformations": [],
    "zip": "90804"
}

A successful request will return a 200 response code with a serialized copy of the Partner object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Delete Partner

This request deletes a partner. This action is not possible to accomplish until the selected partner owns sub-partners. All sub-partner accounts must be deleted before a parent partner is deleted.

Path Arguments

Sample Curl Command

curl -X DELETE \
'https://api.carrierx.com/core/v2/partners/aeda835c-6627-4f4c-ac73-9edcae95640b' \
-u '[your_user_name]:[your_password]'

A successful request will return a 204 response code with an empty body. Refer to the HTTP Status Codes section for a comprehensive list of errors.

Billing Method Object Reference

This section goes over the parts of the Billing Method object. These fields and values make up the JSON response that gets returned when a request is successful.

Register Billing Method

curl -X POST \
'https://api.carrierx.com/core/v2/partners/ed437757-002d-4ecc-aa5a-efdf5e50dba0/billing_method' \
-H 'Accept: application/json' \
--data-binary '{"type":"visa", "cc_number":"4012888818888", "cc_expiration":"022019", "cc_cid":"318", "first_name":"John", "last_name":"Smith", "address1":"4300 E Pacific Coast Hwy", "address2":"Suite 1", "city":"Los Angeles", "state":"CA", "zip":"90804", "country_code":"USA", "phone":"15162065574"}' \
-u '[your_user_name]:[your_password]'

Get Billing Method by Partner SID

curl -X GET \
'https://api.carrierx.com/core/v2/partners/ed437757-002d-4ecc-aa5a-efdf5e50dba0/billing_method' \
-u '[your_user_name]:[your_password]'

Delete Billing Method

curl -X DELETE \
'https://api.carrierx.com/core/v2/partners/ed437757-002d-4ecc-aa5a-efdf5e50dba0/billing_method' \
-u '[your_user_name]:[your_password]'

Phone Numbers

Phone numbers rentable through the CarrierX API are called DIDs. DIDs can be organized into DID Groups. Refer to Get DID Inventory Matching the Specific Criteria to query the phone number inventory for available phone numbers and their capabilities.

Prefixes are a sequence of integers added to the beginning of a phone number that will route incoming calls to the desired recipients. Short codes are short phone numbers used for SMS communications.

DID Object Reference

This section outlines the DID object. The fields listed in the table below will be returned in a JSON object when a successful request has been made.

transformations

This request assigns a DID to a partner account.

Body Arguments

Sample Curl Command

curl -X POST \
'https://api.carrierx.com/core/v2/phonenumber/dids' \
-H 'Content-Type: application/json' \
--data-binary '{"phonenumber":"15162065575", "callback_url":""}'
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "attributes": {},
    "callback_url": null,
    "capabilities": 7,
    "country_code": "USA",
    "did_group_sid": null,
    "did_sid": "f448e2c3-88c1-4cd1-8cf2-3567c16e0794",
    "in_country_format": "(516) 206-5575",
    "international_format": "+1 516-206-5575",
    "locality": "NEW YORK",
    "name": "N/A",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "phonenumber": "15162065575",
    "price": "0.6",
    "state": "NY",
    "transformations": [],
    "trunk_group_sid": null
}

A successful request will return a 200 response code with a serialized copy of the DID object . Below is a common error that arises when getting accounts. Refer to the HTTP Status Codes section for additional errors.

This request returns a list of DIDs that have been rented. This request is enabled for Pagination and Field Filtering. Refer to the Using the REST API section for more information.

Path Arguments

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/dids' \
–u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "count": 1,
    "has_more": true,
    "items": [
        {
            "attributes": {},
            "callback_url": null,
            "capabilities": 7,
            "country_code": "USA",
            "did_group_sid": null,
            "did_sid": "e8df62d5-07a3-4189-a67e-87585067c5fe",
            "in_country_format": "(516) 206-5574",
            "international_format": "+1 516-206-5574",
            "locality": "NEW YORK",
            "name": "N/A",
            "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
            "phonenumber": "15162065574",
            "price": "0.6",
            "state": "NY",
            "transformations": [],
            "trunk_group_sid": null
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {
        "next": "https://api.carrierx.com/core/v2/phonenumber/dids?limit=1&offset=1"
    },
    "total": 2
}

A successful request will return a 200 response code with a serialized copy of the DID object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

This request returns data about a DID, targeted by secure ID. This request is enabled for Field Filtering .

Path Arguments

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/dids/e8df62d5-07a3-4189-a67e-87585067c5fe' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "attributes": {},
    "callback_url": null,
    "capabilities": 7,
    "country_code": "USA",
    "did_group_sid": null,
    "did_sid": "e8df62d5-07a3-4189-a67e-87585067c5fe",
    "in_country_format": "(516) 206-5574",
    "international_format": "+1 516-206-5574",
    "locality": "NEW YORK",
    "name": "N/A",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "phonenumber": "15162065574",
    "price": "0.6",
    "state": "NY",
    "transformations": [],
    "trunk_group_sid": null
}

A successful request will return a 200 response code with a serialized copy of the DID object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

A DID can be updated through PATCH and PUT requests. A PATCH request requires the DID secure ID passed in the query URL, and the specific parameters and values to be updated passed in the request body. A PUT request requires the DID secure ID passed in the query URL, as well as the entire DID object passed in the query body.

The request below will PATCH an existing DID object. PATCH can be used to add or edit fields and values of a DID object. The DID secure ID is passed in the query URL and the values to be changed are passed in the request body.

Path Arguments

Body Arguments

Sample Curl Command

curl -X PATCH \
'https://api.carrierx.com/core/v2/phonenumber/dids/e8df62d5-07a3-4189-a67e-87585067c5fe' \
-H 'Content-Type: application/json' \
--data-binary '{"attributes":{"name":"main line"}}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "attributes": {
        "name": "main line"
    },
    "callback_url": null,
    "capabilities": 7,
    "country_code": "USA",
    "did_group_sid": null,
    "did_sid": "e8df62d5-07a3-4189-a67e-87585067c5fe",
    "in_country_format": "(516) 206-5574",
    "international_format": "+1 516-206-5574",
    "locality": "NEW YORK",
    "name": "N/A",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "phonenumber": "15162065574",
    "price": "0.6",
    "state": "NY",
    "transformations": [],
    "trunk_group_sid": null
}

A successful request will return a 200 response code with a serialized copy of the DID object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

The PUT request below can be used to update an entire DID object.

Path Arguments

Body Arguments

Sample Curl Command

curl -X PUT \
'https://api.carrierx.com/core/v2/phonenumber/dids/e8df62d5-07a3-4189-a67e-87585067c5fe' \
-H 'Content-Type: application/json' \
--data-binary '{"attributes": {"name": "main line", "new_name":"secondary line"}, "callback_url": null, "capabilities": 7, "country_code": "USA", "did_group_sid": null, "did_sid": "e8df62d5-07a3-4189-a67e-87585067c5fe", "in_country_format": "(516) 206-5574", "international_format": "+1 516-206-5574", "locality": "NEW YORK", "name": "N/A", "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f", "phonenumber": "15162065574", "price": "0.6", "state": "NY","transformations": [], "trunk_group_sid": null}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "attributes": {
        "name": "main line",
        "new_name": "secondary line"
    },
    "callback_url": null,
    "capabilities": 7,
    "country_code": "USA",
    "did_group_sid": null,
    "did_sid": "e8df62d5-07a3-4189-a67e-87585067c5fe",
    "in_country_format": "(516) 206-5574",
    "international_format": "+1 516-206-5574",
    "locality": "NEW YORK",
    "name": "N/A",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "phonenumber": "15162065574",
    "price": "0.6",
    "state": "NY",
    "transformations": [],
    "trunk_group_sid": null
}

A successful request will return a 200 response code with a serialized copy of the DID object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

This request releases a DID from a partner account. The same DID cannot be immediately rented again. To recover a released phone number, contact technical support at support@carrierx.com .

Path Arguments

Sample Curl Command

curl -X DELETE \
'https://api.carrierx.com/core/v2/phonenumber/dids/e8df62d5-07a3-4189-a67e-87585067c5fe' \
-u '[your_user_name]:[your_password]'

A successful request will return a 204 response code with an empty body. Refer to the HTTP Status Codes section for a comprehensive list of errors.

Body Arguments

Sample Curl Command

curl -X POST \
'https://api.carrierx.com/core/v2/phonenumber/did_groups' \
-H 'Content-Type: application/json' \
--data-binary '{}'
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "did_group_sid": "41e21049-e5eb-433c-a93d-d57417b1863c",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "name": "N/A"
}

A successful request will return a 200 response code with a serialized copy of the DID Group object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/did_groups?limit=1' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "offset": 0,
    "limit": 1,
    "count": 1,
    "total": 2,
    "has_more": true,
    "pagination": {
        "next": "https://api.carrierx.com/core/v2/phonenumber/did_groups?limit=1&offset=1"
    },
    "items": [
        {
            "did_group_sid": "41e21049-e5eb-433c-a93d-d57417b1863c",
            "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
            "name": "N/A"
        }
    ]
}

A successful request will return a 200 response code with a serialized copy of the DID Group object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Path Arguments

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/did_groups/41e21049-e5eb-433c-a93d-d57417b1863c' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "did_group_sid": "41e21049-e5eb-433c-a93d-d57417b1863c",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "name": "N/A"
}

A successful request will return a 200 response code with a serialized copy of the DID Group object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Path Arguments

Body Arguments

Sample Curl Command

curl -X PATCH \
'https://api.carrierx.com/core/v2/phonenumber/did_groups/41e21049-e5eb-433c-a93d-d57417b1863c' \
-H 'Content-Type: application/json' \
--data-binary '{"name":"my_did_group"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "did_group_sid": "41e21049-e5eb-433c-a93d-d57417b1863c",
    "name": "my_did_group",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f"
}

A successful request will return a 200 response code with a serialized copy of the DID Group object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

The PUT request below can be used to update an entire DID object.

Path Arguments

Body Arguments

Sample Curl Command

curl -X PUT \
'https://api.carrierx.com/core/v2/phonenumber/did_groups/41e21049-e5eb-433c-a93d-d57417b1863c' \
-H 'Content-Type: application/json' \
--data-binary '{"did_group_sid": "41e21049-e5eb-433c-a93d-d57417b1863c", "name": "renamed_did_group", "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
  "did_group_sid": "41e21049-e5eb-433c-a93d-d57417b1863c",
  "name": "renamed_did_group",
  "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f"
}

A successful request will return a 200 response code with a serialized copy of the DID Group object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Path Arguments

Sample Curl Command

curl -X DELETE \
'https://api.carrierx.com/core/v2/phonenumber/did_groups/41e21049-e5eb-433c-a93d-d57417b1863c' \
-u '[your_user_name]:[your_password]'

A successful request will return a 204 response code with an empty body. Refer to the HTTP Status Codes section for a comprehensive list of errors.

Body Arguments

Sample Curl Command

curl -X POST \
'https://api.carrierx.com/core/v2/phonenumber/prefixes' \
-H 'Content-Type: application/json' \
--data-binary '{"prefix":"111111111111111"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "attributes": {},
    "callback_url": null,
    "name": "N/A",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "prefix": "111111111111111",
    "prefix_sid": "cc367acb-94c8-418f-b247-85dce5806ef4",
    "transformations": [],
    "trunk_group_sid": null
}

A successful request will return a 200 response code with a serialized copy of the Prefix object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Get Rates Matching the Specified Criteria

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/rates?limit=1' \
-u '[your_user_name]:[your_password]'

Look Up Rates by Phone Number

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/rates/15162065319?limit=1' \
-u '[your_user_name]:[your_password]'

Create Application to Send Push Notifications

curl -X POST \
'https://api.carrierx.com/core/v2/push/applications' \
-H 'Content-Type: application/json' \
--data-binary '{"google_id":"", "google_key":"", "apns_id":"", "apns_p12":"", "apns_p12_password":""}' \
-u '[your_user_name]:[your_password]'

Get Applications Matching the Specified Criteria

curl -X GET \
'https://api.carrierx.com/core/v2/push/applications?limit=1' \
-u '[your_user_name]:[your_password]'

Get Application by SID

curl -X GET \
'https://api.carrierx.com/core/v2/push/applications/8b03edc1-5378-4c4e-a480-9015206089dc' \
-u '[your_user_name]:[your_password]'

Update Application

curl -X PATCH \
'https://api.carrierx.com/core/v2/push/applications/8b03edc1-5378-4c4e-a480-9015206089dc' \
-H 'Content-Type: application/json' \
--data-binary '{"name": "another name"}' \
-u '[your_user_name]:[your_password]'

Shortener

The Shortener API takes URLs and creates shortened versions of those URLs. Once created and configured in the proper DNS records, the links are usable. A Domain object is created first, followed by a Link object.

Domain Object Reference

This section outlines the Domain object. The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Create Domain

This request creates a new Domain object.

Body Arguments

Sample Curl Command

curl -X POST \
'https://api.carrierx.com/core/v2/shortener/domains' \
-H "Content-Type: application/json" \
--data-binary '{"domain_name":"newdomain.com"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "domain_name": "newdomain.com",
    "domain_sid": "a0625551-63de-428e-889d-2d467b4e77a3",
    "expired_mode": "redirect_temporary",
    "expired_page": null,
    "expired_status_code": null,
    "minimum_length": 6,
    "not_found_mode": "redirect_temporary",
    "not_found_page": null,
    "not_found_status_code": null,
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "scope": "children",
    "secure": "disabled",
    "suffix_pattern": null
}

A successful request will return a 200 response code with a serialized copy of the Domain object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Get Domains Matching the Specified Criteria

This request returns a list of existing domains for the currently logged in partner. This request is enabled for Pagination and Field Filtering. Refer to the Using the REST API section for more information.

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/shortener/domains' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "domain_name": "newdomain.com",
            "domain_sid": "a0625551-63de-428e-889d-2d467b4e77a3",
            "expired_mode": "redirect_temporary",
            "expired_page": null,
            "expired_status_code": null,
            "minimum_length": 6,
            "not_found_mode": "redirect_temporary",
            "not_found_page": null,
            "not_found_status_code": null,
            "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
            "scope": "children",
            "secure": "disabled",
            "suffix_pattern": null
        }
    ],
    "limit": 1000,
    "offset": 0,
    "pagination": {},
    "total": 1
}

A successful request will return a 200 response code with a serialized copy of the Domain object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Get Domain by SID

This request fetches information for the specified Domain object, targeted by secure ID. This request is enabled for Field Filtering .

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/shortener/domains/a0625551-63de-428e-889d-2d467b4e77a3' \
-u '[your_user_name]:[your_password]'

Path Arguments

Sample JSON Response

{
    "domain_name": "newdomain.com",
    "domain_sid": "a0625551-63de-428e-889d-2d467b4e77a3",
    "expired_mode": "redirect_temporary",
    "expired_page": null,
    "expired_status_code": null,
    "minimum_length": 6,
    "not_found_mode": "redirect_temporary",
    "not_found_page": null,
    "not_found_status_code": null,
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "scope": "children",
    "secure": "disabled",
    "suffix_pattern": null
}

A successful request will return a 200 response code with a serialized copy of the Domain object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Update Domain

A domain can be updated through PATCH and PUT requests. A PATCH request requires the domain secure ID passed in the query URL, and the specific parameters and values to be updated passed in the request body. A PUT request requires the domain secure ID passed in the query URL, as well as the entire Domain object passed in the query body.

Path Arguments

Body Arguments

Sample Curl Command

curl -X PATCH \
'https://api.carrierx.com/core/v2/shortener/domains/a0625551-63de-428e-889d-2d467b4e77a3' \
-H 'Content-Type: application/json' \
--data-binary '{"domain_name":"mywebsite.com"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "domain_name": "mywebsite.com",
    "domain_sid": "a0625551-63de-428e-889d-2d467b4e77a3",
    "expired_mode": "redirect_temporary",
    "expired_page": null,
    "expired_status_code": null,
    "minimum_length": 6,
    "not_found_mode": "redirect_temporary",
    "not_found_page": null,
    "not_found_status_code": null,
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "scope": "children",
    "secure": "disabled",
    "suffix_pattern": null
}

A successful request will return a 200 response code with a serialized copy of the Domain object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

The PUT request below can be used to update an entire Domain object. The domain secure ID is passed in the query URL and the body parameter is passed in the request body.

Path Arguments

Body Arguments

Sample Curl Command

curl -X PUT \
'https://api.carrierx.com/core/v2/shortener/domains/a0625551-63de-428e-889d-2d467b4e77a3' \
-H "Content-Type: application/json" \
--data-binary '{"domain_name": "mynewwebsite.com", "domain_sid": "a0625551-63de-428e-889d-2d467b4e77a3", "expired_mode": "redirect_temporary", "expired_page": null, "expired_status_code": null, "minimum_length": 6, "not_found_mode": "redirect_temporary", "not_found_page": null, "not_found_status_code": null, "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f", "scope": "children", "secure": "disabled", "suffix_pattern": null}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "domain_name": "mynewwebsite.com",
    "domain_sid": "a0625551-63de-428e-889d-2d467b4e77a3",
    "expired_mode": "redirect_temporary",
    "expired_page": null,
    "expired_status_code": null,
    "minimum_length": 6,
    "not_found_mode": "redirect_temporary",
    "not_found_page": null,
    "not_found_status_code": null,
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "scope": "children",
    "secure": "disabled",
    "suffix_pattern": null
}

A successful request will return a 200 response code with a serialized copy of the Domain object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Delete Domain

This request deletes a domain, targeted by secure ID.

Path Arguments

Sample Curl Command

curl -X DELETE \
'https://api.carrierx.com/core/v2/shortener/domains/a0625551-63de-428e-889d-2d467b4e77a3' \
-u '[your_user_name]:[your_password]'

A successful request will return a 204 response code with an empty body. Refer to the HTTP Status Codes section for a comprehensive list of errors.

Link Object Reference

This section describes the elements of the Link object. These fields and values make up the JSON object that gets returned with successful requests.

Create Link

This request creates a new Link object.

Path Arguments

Sample Curl Command

curl -X POST \
'https://api.carrierx.com/core/v2/shortener/links' \
-H "Content-Type: application/json" \
--data-binary '{"domain_sid":"330a8a83-d4bb-4f39-ae54-c59c8d87cd44", "destination_url":"http://destinationurl.com", "maximum_ttl":"-1"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "date_accessed": null,
    "date_created": "2019-01-18T19:26:02.553Z",
    "destination_url": "http://destinationurl.com",
    "domain_sid": "330a8a83-d4bb-4f39-ae54-c59c8d87cd44",
    "hits": 0,
    "link_sid": "a533f53a-7e6f-4822-be3c-3767924ee2a9",
    "maximum_ttl": -1,
    "mode": "redirect_temporary",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "short_name": "eOtEtO",
    "url": "http://newdomain.com/eOtEtO"
}

A successful request will return a 200 response code with a serialized copy of the Link object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Get Links Matching the Specified Criteria

This request returns a list of existing links for the currently logged in partner. This request is enabled for Pagination and Field Filtering. Refer to the Using the REST API section for more information.

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/shortener/links' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "date_accessed": null,
            "date_created": "2019-01-18T19:26:02.000Z",
            "destination_url": "http://destinationurl.com",
            "domain_sid": "330a8a83-d4bb-4f39-ae54-c59c8d87cd44",
            "hits": 0,
            "link_sid": "a533f53a-7e6f-4822-be3c-3767924ee2a9",
            "maximum_ttl": -1,
            "mode": "redirect_temporary",
            "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
            "short_name": "eOtEtO",
            "url": "http://newdomain.com/eOtEtO"
        }
    ],
    "limit": 1000,
    "offset": 0,
    "pagination": {},
    "total": null
}

A successful request will return a 200 response code with a serialized copy of the Link object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Get Link by SID

This request returns information for a Link object. This request is enabled for Field Filtering .

Path Arguments

Sample Curl Command

curl -X GET \
'https://api.carrierx.com/core/v2/shortener/links/a533f53a-7e6f-4822-be3c-3767924ee2a9' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "date_accessed": null,
    "date_created": "2019-01-18T19:26:02.000Z",
    "destination_url": "http://destinationurl.com",
    "domain_sid": "330a8a83-d4bb-4f39-ae54-c59c8d87cd44",
    "hits": 0,
    "link_sid": "a533f53a-7e6f-4822-be3c-3767924ee2a9",
    "maximum_ttl": -1,
    "mode": "redirect_temporary",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "short_name": "eOtEtO",
    "url": "http://newdomain.com/eOtEtO"
}

A successful request will return a 200 response code with a serialized copy of the Link object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Update Link

A link can be updated using PATCH and PUT requests. A PATCH request can be used to update one or more attribute values. When using a PATCH request, only the attributes specified in the request will be updated. All other attributes and values will remain the same. The link secure ID is passed in the query URL, and the parameters are passed in the request body.

Path Arguments

Body Arguments

Sample Curl Command

curl -X PATCH \
'https://api.carrierx.com/core/v2/shortener/links/a533f53a-7e6f-4822-be3c-3767924ee2a9' \
-H 'Content-Type: application/json' \
--data-binary '{"mode":"redirect_permanent"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "date_accessed": null,
    "date_created": "2019-01-18T19:26:02.000Z",
    "destination_url": "http://destinationurl.com",
    "domain_sid": "330a8a83-d4bb-4f39-ae54-c59c8d87cd44",
    "hits": 0,
    "link_sid": "a533f53a-7e6f-4822-be3c-3767924ee2a9",
    "maximum_ttl": -1,
    "mode": "redirect_permanent",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "short_name": "eOtEtO",
    "url": "http://newdomain.com/eOtEtO"
}

A successful request will return a 200 response code with a serialized copy of the Link object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

A PUT request can be used to update the entire Link object. This request can be used to remove, add, and modify values. The link secure ID is passed in the query URL and the body parameters and values are passed in the request body.

Path Arguments

Body Arguments

Sample Curl Command

curl -X PUT \
'https://api.carrierx.com/core/v2/shortener/links/a533f53a-7e6f-4822-be3c-3767924ee2a9' \
--data-binary '{"date_accessed": null, "date_created": "2019-01-18T19:26:02.000Z", "destination_url": "http://destinationurl.com", "domain_sid": "330a8a83-d4bb-4f39-ae54-c59c8d87cd44", "hits": 0, "link_sid": "a533f53a-7e6f-4822-be3c-3767924ee2a9", "maximum_ttl": -1,"mode": "redirect_temporary", "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f", "short_name": "eOtEtO", "url": "http://newdomain.com/eOtEtO"}' \
-u '[your_user_name]:[your_password]'

Sample JSON Response

{
    "date_accessed": null,
    "date_created": "2019-01-18T19:26:02.000Z",
    "destination_url": "http://destinationurl.com",
    "domain_sid": "330a8a83-d4bb-4f39-ae54-c59c8d87cd44",
    "hits": 0,
    "link_sid": "a533f53a-7e6f-4822-be3c-3767924ee2a9",
    "maximum_ttl": -1,
    "mode": "redirect_temporary",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "short_name": "eOtEtO",
    "url": "http://newdomain.com/eOtEtO"
}

A successful request will return a 200 response code with a serialized copy of the Link object . Refer to the HTTP Status Codes section for common errors that may arise when making requests.

Delete Link

This request deletes a link, targeted by secure ID.

Path Arguments

Sample Curl Command

curl -X DELETE \
'https://api.carrierx.com/core/v2/shortener/links/a533f53a-7e6f-4822-be3c-3767924ee2a9' \
-u '[your_user_name]:[your_password]'

A successful request will return a 204 response code with an empty body. Refer to the HTTP Status Codes section for a comprehensive list of errors.

SMS Object Reference

This section outlines the SMS object. The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Send SMS Message

curl -X POST \
'https://api.carrierx.com/core/v2/sms/messages' \
-H 'Content-Type: application/json' \
--data-binary '{"from_did":"15162065575", "to_did":"15162065574", "message":"This is a test message"}'
-u '[your_user_name]:[your_password]'

Get SMS Messages Matching the Specified Criteria

curl -X GET \
'https://api.carrierx.com/core/v2/sms/messages?limit=1' \
-u '[your_user_name]:[your_password]'

Get SMS Message by SID

curl -X GET \
'https://api.carrierx.com/core/v2/sms/messages/097b49df-c54e-4eaf-97d0-89cf7d5a655b' \
-u '[your_user_name]:[your_password]'

Get Outbound Rates Matching the Specified Criteria

curl -X GET \
'https://api.carrierx.com/core/v2/sms/rates/outbound?limit=1' \
-u '[your_user_name]:[your_password]'

Container Object Reference