Introduction

Welcome to the CarrierX RESTful API Reference Guide. This API Reference Guide will help you tap into the fundamental capabilities of the CarrierX platform through RESTful verbs to enable your application with Voice, Conference Calling, SMS and Verification services.

This API Reference Guide provides a simple and standardized RESTful interface with JSON formatted responses that can be used by developers to create connectivity between their applications and our communication infrastructure.

For immediate instruction, browse our Table of Contents to the left and jump to the specific section of interest.

There are four primary services that this API Reference Guide will allow you to provision.

These services are:

• Phone Numbers: Customers can easily rent phone numbers through their CarrierX portal that are enabled with both audio and sms capabilities.
• SMS Solutions: Utilizing either rented phone numbers or short codes, users can enable long code messaging and user verification workflows for their apps.
• SIP Trunking: Quickly provision and support your application with high-quality audio with CarrierX SIP trunking.
• Application Endpoints: Quickly provision robust, full-featured applications that can help deliver a voice-rich customer experience through redirecting, merging or hosting high-volume calls.

These four core capabilities work in concert to make up the breadth of capabilities available to customers with the CarrierX infrastructure. Through simple RESTful services we help you connect millions of callers daily and deliver international outbound services to more than 50 countries.

Enabling communication services at disruptive pricing has never been easier.

The CarrierX API can be accessed from the following base URL:

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

All data is sent and received in the JSON format and all of your API requests will require authentication. If you have not yet obtained your CarrierX account, please provide your email address on the homepage to create your free account.

If you prefer, you can contact our customer service team by phone to help you get started: (844) 844-1322.

Partners

Shows the list of Partners. If no filter is specified, the number of displayed items will be limited by the limit and offset values only. If the number of items exceeds the limit value, the has_more value in the response will be set to true, pagination field will suggest moving either to the next page or to the previous one. If you want to obtain data about a particular partner but cannot remember partner_sid, filter.
To see all sub-partner accounts for a particular partner, set filter to parent_sid eq 'partner_sid' and send the request.
Use the order and include_fields / exclude_fields parameters to adjust the response to your convenience.

Alongside with the items, the GET request will also return the following information:

  {
          "offset": 0,
          "limit": 10,
          "count": 10,
          "total": 541,
          "has_more": true,
          "pagination": {
              "next": "https://api.carrierx.com/core/v2/partners?limit=10&offset=10"
      }

Sample URL

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/partners?limit=100&filter=name%20eq%20%22PQA_03%22%20and%20parent_sid%20ne%200'

Parameters

Sample Response

  {
      "display_id": "CX49260055",
      "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
      "login": "fcc_login",
      "name": "Frederick K. Walker",
      "parent_sid": "lbVk92xwB-eKLZKlahZkPR9O7JBp8Y-f",
      "date_created": "2016-10-25T07:10:24.000Z",
      "balance": "-0.63",
      "owner_email": "aerialme0@yandex.ru",
      "billing_email": "aerialme0@yandex.ru",
      "tech_email": "oleni.lu4she@gmail.com",
      "company_name": "fcc77",
      "address1": "14802020698",
      "address2": null,
      "city": "Phoenix",
      "state": "AZ",
      "zip": "85034",
      "country_code": "USA",
      "attributes": {},
      "payment_type": "postpay",
      "prepay_amount": null,
      "charge_at": null,
      "callbacks": {},
      "acls": [],
      "parent_assigned_acls": [],
      "transformations": [
          {
              "direction": "outbound",
              "action": "rewrite_to",
              "operands": [
                  "9999",
                  "18884521505"
                ]
          }
      ],
      "status": "active",
      "phonenumber": "180045012323"
  }

Attributes

This will add a new partner to the structure. The mandatory parameters are login, password, zip, country_code, owner_email. password value is seen only when sending the POST request and it is hidden in the response. If the full address is not specified at the creation step, it can be added later on with a PATCH call. Each partner is created with a unique login. If you try to add a partner with the “login” value already registered in the system, the call will return Response 400. Object validation error. parent_sid is specified, the secure ID of the Master account will be taken.

At the creation step, all partners can be determined as postpay or prepay:

• Partners whth ‘payment_type’ set to ‘postpay’ are expected to pay for using CarrierX services at the end of each billing period (on a monthly basis)
• Partners with ‘payment_type’ set to ‘prepay’ are expected to pay in advance using the services. The exceptable amount is defined in the prepay_amount attribute. The min possible value is ‘5’ (i.e. Partner can have at least 5 dollars on his account), and the max acceptable prepay amount is 1000. The charge_at parameter defines the lower margine. Once it is reached, the Partner will be charged for the same amount of money specified in the prepay_amount.
  
  Each Partner can control what calls can be placed or received with the help of Access Control Lists (ACL). Access Control List (ACL) consists of the list of List of Access Control Rules, i.e. single checks that determine the scope of data to be checked in SIP calls.
  
  ACL’s can exist both on the Partner and on the Trunk Group levels.
  On the Partner level, ACLs are defined in acls and parent_assigned_acls attributes.
  
  Note : acls can be set up only by the Partner himself.
  Note : parent_assigned_acls can be set up only by the Partner’s parent.
  
  ACL’s cannot be shared between Partner and his sub Partners, and have to be created specifically for each partner. If not done at the creation step, ACL’s can be added later with a PATCH or PUT calls.
  
  sms_action_true and sms_action_false define what action is to be executed for a particular ACL. Possible values are reject and accept.
  voice_action_true and voice_action_false define what action is to be executed for a particular ACL. Possible values are reject403, reject503, accept.
  
  Note : [sms/voice]_action_false or [sms/voice]_action_false is set to one of above values, the other one should be set to null. They cannot be set to some value simultaneously.
  For example: sms_action_true: “accept”, sms_action_false: null
  
  

  Email Management

  Each partner has 3 email addresses:

  • owner_email - Partner primary email;
  • billing_email - Partner email used for billing purposes; owner_email is used if empty
  • tech_email - Partner email used for technical purposes; owner_email is used if empty

   

  owner_email the only mandatory email address field which cannot be empty. It will remain Partner’s major contact  which will be used if his other email addresses

   

  Basic Workflow

  As soon as a new Partner is added to the system, we send a verification message to his email address (the one provided as owner_email).

  The email body will contain a link with a token, clicking which Partner will confirm his email address and his readiness to use CarrierX services. Until then, partner’s email address will not be shown as ‘owner_email’.

  If Partner skips the email confirmation step, his status in the system will remain unconfirmed, i.e. he won't be able to use any of the CarrierX services.

  Once the address is confirmed, the email value will show up in owner_email field and will be used as Partner's primary contact address.

  The same workflow applies to the other 2 email addresses (billing_email and tech_email addresses):

  Important: if the tech_email and/or billing_email coincide with the owner_email value, no new confirmation email is sent, and the email values are set up automatically.

  However, if the tech_email and/or billing_email do NOT coincide with the owner_email value, the confirmation email is sent to each newly specified email

  METHOD	URL
  POST	/partners

  
  

  Sample URL

  
  curl -X POST --header 'Content-Type: application/json' -d '{"login":"fcc_login", "password":"fcc_password", "name":"Mary C. Burge", "company_name": "ABC", "parent_sid":"", "country_code":"USA", "zip":"92701", "owner_email": "MaryCBurge@teleworm.us", "payment_type": "postpay", "phonenumber": "180045012323"}' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/partners'
  

  
  

  Parameters

  Parameter	Data Type	Description
  body req	...	Body of the Partner to be created.

  
  

  Sample Response

    {
        "display_id": "CX49260055",
        "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
        "login": "fcc_login ",
        "name": "Mary C. Burge ",
        "parent_sid": "lbVk92xwB-eKLZKlahZkPR9O7JBp8Y-f",
        "date_created": "2016-10-25T07:10:24.000Z",
        "balance": "5",
        "owner_email": "MaryCBurge@teleworm.us",
        "billing_email": "MaryCBurge@teleworm.us",
        "tech_email": "MaryCBurge@teleworm.us",
        "company_name": "ABC ",
        "address1": "Colebrook way 17",
        "address2": null,
        "city": "",
        "state": "",
        "zip": "92701",
        "country_code": "USA",
        "attributes": {},
        "payment_type": "postpay",
        "prepay_amount": null,
        "charge_at": null,
        "callbacks": {},
        "acls": [],
        "parent_assigned_acls": [],
        "transformations": [],
        "status": "active",
        "phonenumber": "180045012323"
    }

  
  

  Attributes

  Attribute			Data Type	Description
  display_id			string	Partner unique ID
  partner_sid opt			string	Partner secure ID
  parent_sid opt			string	Parent Partner secure ID
  name opt			string	Partner name
  login			string	Login to the web or WS API
  password			string	Password to the web or WS API. The field is hidden
  date_created opt			string	Date and time when the partner was created
  owner_email			string	Partner primary email,
  billing_email			string	Partner email used for billing purposes; owner_email is used if empty
  tech_email			string	Partner email used for technical purposes; owner_email is used if empty
  company_name			string	Partner company name
  status			string	Status of the partner. Possible values: deleted – partner was removed active –partner is active canceled – partner was canceled suspended – partner’s account has been suspended because his balance went lower the acceptable limit unverified – partner’s email has not been verified unconfirmed – partner has not been confirmed
  phonenumber			string	Partner contact phone number
  callbacks	sms_callback_url opt		string	Callback URL for sms
  acls opt	acl	direction	string	Direction for ACL. Possible values: inbound, outbound, any
  		voice_action_true	string	Action to be executed for call if any of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		voice_action_false	string	Action to be executed for call if none of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		sms_action_true	string	Action to be executed for sms if any of Access Control Rules is applied. Possible values: accept, reject
  		sms_action_false	string	Action to be executed for sms if none of Access Control Rules is applied. Possible values: accept, reject
  		access_control_rules	array	List of Access Control Rule Secure IDs
  parent_assigned_acls	acl	direction	string	Direction for ACL. Possible values: inbound, outbound, any
  		voice_action_true	string	Action to be executed for call if any of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		voice_action_false	string	Action to be executed for call if none of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		sms_action_true	string	Action to be executed for sms if any of Access Control Rules is applied. Possible values: accept, reject
  		sms_action_false	string	Action to be executed for sms if none of Access Control Rules is applied. Possible values: accept, reject
  		access_control_rules	array	List of Access Control Rule Secure IDs
  transformations		direction	string	Direction for transformation: inbound, outbound, any
  		action	string	Action to be executed for transformation: rewrite_to, rewrite_from
  		operands	array	Value(s) to be used for "action"
  balance opt			integer	Current balance of the Partner
  address1			string	Partner address
  address2			string	Partner address
  city			string	Partner city
  zip			string	Partner zip code
  country_code			string	Partner country ISO 3166-1 alpha-3 code
  prepay_amount			integer	Charge amount for prepay customers
  charge_at			integer	Balance value when prepay account will be charged
  payment_type			string	Type of payment. Posible values: prepay postpay

  
  

  Remove Partner

  This call will remove one of your Partners from the structure. This action is not possible to accomplish until the selected Partner owns sub-partners. Ensure you delete the total sub-partner accounts structure prior to removing the parent one.

  METHOD	URL
  DELETE	/partners/{partner_sid}

  
  

  Sample URL

  
  curl -X DELETE --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/partners/ILaI971X9-cKufSR.DrUFgqGbufXomDq'
  

  
  

  Parameters

  Parameter	Data Type	Description
  partner_sid req	string	Secure ID of the Partner to be removed

  Get Partner by SID

  This call will return information for a single Partner whose secure ID is used to retrieve the data. You may use include_fields / exclude_fields parameters to refine the response.

  METHOD	URL
  GET	/partners/{partner_sid}

  
  

  Sample URL

  
  curl -X GET --header 'Content-Type: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/partners/6feb0f8b-f104-4445-8db8-593c5e5cb7ee'
  

  
  

  Parameters

  Parameter	Data Type	Description
  partner_sid req	string	Partner secure ID
  include_fields	string	Comma separated list of fields that should be included in the response
  exclude_fields	string	Comma separated list of fields that should be excluded from the response

  
  

  Sample Response

   {
            "display_id": "CX49260055",
            "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
            "login": "fcctest_anovikova",
            "name": "Frederick K. Walker",
            "parent_sid": "lbVk92xwB-eKLZKlahZkPR9O7JBp8Y-f",
            "date_created": "2016-10-25T07:10:24.000Z",
            "balance": "-0.63",
            "owner_email": "aerialme0@yandex.ru",
            "billing_email": "aerialme0@yandex.ru",
            "tech_email": "oleni.lu4she@gmail.com",
            "company_name": "fcc77",
            "address1": "14802020698",
            "address2": null,
            "city": "Phoenix",
            "state": "AZ",
            "zip": "85034",
            "country_code": "USA",
            "attributes": {},
            "payment_type": "postpay",
            "prepay_amount": null,
            "charge_at": null,
            "callbacks": {},
            "acls": [],
            "parent_assigned_acls": [],
            "transformations": [
                {
                    "direction": "outbound",
                    "action": "rewrite_to",
                    "operands": [
                        "9999",
                        "18884521505"
                    ]
                }
            ],
            "status": "active",
            "phonenumber": "180045012323"
    }

  
  

  Attributes

  Attribute			Data Type	Description
  display_id			string	Partner unique ID
  partner_sid opt			string	Partner secure ID
  parent_sid opt			string	Parent Partner secure ID
  name opt			string	Partner name
  login			string	Login to the web or WS API
  password			string	Password to the web or WS API. The field is hidden
  date_created opt			string	Date and time when the partner was created
  owner_email			string	Partner primary email,
  billing_email			string	Partner email used for billing purposes; owner_email is used if empty
  tech_email			string	Partner email used for technical purposes; owner_email is used if empty
  company_name			string	Partner company name
  status			string	Status of the partner. Possible values: deleted – partner was removed active –partner is active canceled – partner was canceled suspended – partner’s account has been suspended because his balance went lower the acceptable limit unverified – partner’s email has not been verified unconfirmed – partner has not been confirmed
  phonenumber			string	Partner contact phone number
  callbacks	sms_callback_url opt		string	Callback URL for sms
  acls opt	acl	direction	string	Direction for ACL. Possible values: inbound, outbound, any
  		voice_action_true	string	Action to be executed for call if any of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		voice_action_false	string	Action to be executed for call if none of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		sms_action_true	string	Action to be executed for sms if any of Access Control Rules is applied. Possible values: accept, reject
  		sms_action_false	string	Action to be executed for sms if none of Access Control Rules is applied. Possible values: accept, reject
  		access_control_rules	array	List of Access Control Rule Secure IDs
  parent_assigned_acls	acl	direction	string	Direction for ACL. Possible values: inbound, outbound, any
  		voice_action_true	string	Action to be executed for call if any of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		voice_action_false	string	Action to be executed for call if none of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		sms_action_true	string	Action to be executed for sms if any of Access Control Rules is applied. Possible values: accept, reject
  		sms_action_false	string	Action to be executed for sms if none of Access Control Rules is applied. Possible values: accept, reject
  		access_control_rules	array	List of Access Control Rule Secure IDs
  transformations		direction	string	Direction for transformation: inbound, outbound, any
  		action	string	Action to be executed for transformation: rewrite_to, rewrite_from
  		operands	array	Value(s) to be used for "action"
  balance opt			integer	Current balance of the Partner
  address1			string	Partner address
  address2			string	Partner address
  city			string	Partner city
  zip			string	Partner zip code
  country_code			string	Partner country ISO 3166-1 alpha-3 code
  prepay_amount			integer	Charge amount for prepay customers
  charge_at			integer	Balance value when prepay account will be charged
  payment_type			string	Type of payment. Posible values: prepay postpay

  
  

  Patch Partner

  This call performs a partial update of the Partner. You may use it to change partner’s password, update address, to add or remove objects like acls, transformations.
  Note: only parameters specified in the call will be updated. The other will preserce their current value. Arrays of complex objects (like alcs, transformations) get totally replaced by the new values. If a PATCH call contains an acl or transformation object, it will totally replace the existing one if any. In order to add a new transformation or acl, send the request containing both the existing object(s) and the one to be added.
  Note: acls can be set up or updated only by the Partner himself.
  Note: parent_assigned_acls can be set up or updated only by the Partner’s parent.
  
  sms_action_true and sms_action_false define what action is to be executed for a particular ACL. Possible values are reject and accept.
  
  Note: If either [sms/voice]_action_true or [sms/voice]_action_false is set to one of above values, the other one should be set to null. They cannot be set to some value simultaneously.
  
  For example: voice_action_true: "accept", voice_action_false: null.

  METHOD	URL
  PATCH	/partners/{partner_sid}

  
  

  Sample URL

  
  curl -X PATCH --header 'Content-Type: application/json' –d '{"password":"oc25"}' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/partners/6feb0f8b-f104-4445-8db8-593c5e5cb7ee'
  

  
  

  Parameters

  Parameter	Data Type	Description
  partner_sid req	string	Partner secure ID
  body req	...	Body of the Partner to be patched

  
  
  

  Sample Response

   {
            "display_id": "CX49260055",
            "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
            "login": "fcctest_anovikova",
            "name": "Frederick K. Walker",
            "parent_sid": "lbVk92xwB-eKLZKlahZkPR9O7JBp8Y-f",
            "date_created": "2016-10-25T07:10:24.000Z",
            "balance": "-0.63",
            "owner_email": "aerialme0@yandex.ru",
            "billing_email": "aerialme0@yandex.ru",
            "tech_email": "oleni.lu4she@gmail.com",
            "company_name": "fcc77",
            "address1": "14802020698",
            "address2": null,
            "city": "Phoenix",
            "state": "AZ",
            "zip": "85034",
            "country_code": "USA",
            "attributes": {},
            "payment_type": "postpay",
            "prepay_amount": null,
            "charge_at": null,
            "callbacks": {},
            "acls": [],
            "parent_assigned_acls": [],
            "transformations": [
                {
                    "direction": "outbound",
                    "action": "rewrite_to",
                    "operands": [
                        "9999",
                        "18884521505"
                    ]
                }
            ],
            "status": "active",
            "phonenumber": "180045012323"
    }

  
  

  Attributes

  Attribute			Data Type	Description
  display_id			string	Partner unique ID
  partner_sid opt			string	Partner secure ID
  parent_sid opt			string	Parent Partner secure ID
  name opt			string	Partner name
  login			string	Login to the web or WS API
  password			string	Password to the web or WS API. The field is hidden
  date_created opt			string	Date and time when the partner was created
  owner_email			string	Partner primary email,
  billing_email			string	Partner email used for billing purposes; owner_email is used if empty
  tech_email			string	Partner email used for technical purposes; owner_email is used if empty
  company_name			string	Partner company name
  status			string	Status of the partner. Possible values: deleted – partner was removed active –partner is active canceled – partner was canceled suspended – partner’s account has been suspended because his balance went lower the acceptable limit unverified – partner’s email has not been verified unconfirmed – partner has not been confirmed
  phonenumber			string	Partner contact phone number
  callbacks	sms_callback_url opt		string	Callback URL for sms
  acls opt	acl	direction	string	Direction for ACL. Possible values: inbound, outbound, any
  		voice_action_true	string	Action to be executed for call if any of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		voice_action_false	string	Action to be executed for call if none of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		sms_action_true	string	Action to be executed for sms if any of Access Control Rules is applied. Possible values: accept, reject
  		sms_action_false	string	Action to be executed for sms if none of Access Control Rules is applied. Possible values: accept, reject
  		access_control_rules	array	List of Access Control Rule Secure IDs
  parent_assigned_acls	acl	direction	string	Direction for ACL. Possible values: inbound, outbound, any
  		voice_action_true	string	Action to be executed for call if any of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		voice_action_false	string	Action to be executed for call if none of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		sms_action_true	string	Action to be executed for sms if any of Access Control Rules is applied. Possible values: accept, reject
  		sms_action_false	string	Action to be executed for sms if none of Access Control Rules is applied. Possible values: accept, reject
  		access_control_rules	array	List of Access Control Rule Secure IDs
  transformations		direction	string	Direction for transformation: inbound, outbound, any
  		action	string	Action to be executed for transformation: rewrite_to, rewrite_from
  		operands	array	Value(s) to be used for "action"
  balance opt			integer	Current balance of the Partner
  address1			string	Partner address
  address2			string	Partner address
  city			string	Partner city
  zip			string	Partner zip code
  country_code			string	Partner country ISO 3166-1 alpha-3 code
  prepay_amount			integer	Charge amount for prepay customers
  charge_at			integer	Balance value when prepay account will be charged
  payment_type			string	Type of payment. Posible values: prepay postpay

  
  

  Update Partner

  This call performs a complete update of the Partner. This call can be used both for changing and removing values. The mandatory attributes: login, country_code, zip cannot be null.
  Note: acls can be set up or updated only by the Partner himself.
  Note: parent_assigned_acls can be set up or updated only by the Partner’s parent.
  
  sms_action_true and sms_action_false define what action is to be executed for a particular ACL. Possible values are reject and accept.
  voice_action_true and voice_action_false define what action is to be executed for a particular ACL. Possible values are reject503, reject403, accept.
  Note: If either sms/voice_action_true or sms/voice_action_false is set to one of above values, the other one should be set to null. They cannot be set to some value simultaneously.
  For example: "voice_action_true":"accept", "voice_action_false":null.

  METHOD	URL
  PUT	/partners/{partner_sid}

  
  

  Sample URL

  
  curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' –d  '{"display_id": "CX49260055", "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee", "login": "fcctest_anovikova", "name": "Frederick K. Walker", "parent_sid": "lbVk92xwB-eKLZKlahZkPR9O7JBp8Y-f", "date_created": "2016-10-25T07:10:24.000Z", "balance": "-0.63", "owner_email": "aerialme0@yandex.ru", "billing_email": "aerialme0@yandex.ru", "tech_email": "oleni.lu4she@gmail.com", "company_name": "fcc77", "address1": "14802020698", "address2": null, "city": "Phoenix", "state": "AZ", "zip": "85034", "country_code": "USA", "attributes": {}, "payment_type": "postpay", "prepay_amount": null, "charge_at": null, "callbacks": {}, "acls": [], "parent_assigned_acls": [], "transformations": [ { "direction": "outbound", "action": "rewrite_to", "operands": [ "9999", "18884521505" ] } ], "status": "active", "phonenumber": "180045012323" }' -u [your_user_name]:[your_password]'https://api.carrierx.com/core/v2/partners/6feb0f8b-f104-4445-8db8-593c5e5cb7ee'
  

  
  

  Parameters

  Parameter	Data Type	Description
  partner_sid req	string	Partner secure ID
  body req	...	Body of the Partner to be updated

  
  

  Sample Response

   {
      "display_id": "CX49260055",
      "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
      "login": "fcctest_anovikova",
      "name": "Frederick K. Walker",
      "parent_sid": "lbVk92xwB-eKLZKlahZkPR9O7JBp8Y-f",
      "date_created": "2016-10-25T07:10:24.000Z",
      "balance": "-0.63",
      "owner_email": "aerialme0@yandex.ru",
      "billing_email": "aerialme0@yandex.ru",
      "tech_email": "oleni.lu4she@gmail.com",
      "company_name": "fcc77",
      "address1": "14802020698",
      "address2": null,
      "city": "Phoenix",
      "state": "AZ",
      "zip": "85034",
      "country_code": "USA",
      "attributes": {},
      "payment_type": "postpay",
      "prepay_amount": null,
      "charge_at": null,
      "callbacks": {},
      "acls": [],
      "parent_assigned_acls": [],
      "transformations": [
          {
              "direction": "outbound",
              "action": "rewrite_to",
              "operands": [
                  "9999",
                  "18884521505"
              ]
          }
      ],
      "status": "active",
      "phonenumber": "180045012323"
  }

  
  

  Attributes

  Attribute			Data Type	Description
  display_id			string	Partner unique ID
  partner_sid opt			string	Partner secure ID
  parent_sid opt			string	Parent Partner secure ID
  name opt			string	Partner name
  login			string	Login to the web or WS API
  password			string	Password to the web or WS API. The field is hidden
  date_created opt			string	Date and time when the partner was created
  owner_email			string	Partner primary email,
  billing_email			string	Partner email used for billing purposes; owner_email is used if empty
  tech_email			string	Partner email used for technical purposes; owner_email is used if empty
  company_name			string	Partner company name
  status			string	Status of the partner. Possible values: deleted – partner was removed active –partner is active canceled – partner was canceled suspended – partner’s account has been suspended because his balance went lower the acceptable limit unverified – partner’s email has not been verified unconfirmed – partner has not been confirmed
  phonenumber			string	Partner contact phone number
  callbacks	sms_callback_url opt		string	Callback URL for sms
  acls opt	acl	direction	string	Direction for ACL. Possible values: inbound, outbound, any
  		voice_action_true	string	Action to be executed for call if any of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		voice_action_false	string	Action to be executed for call if none of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		sms_action_true	string	Action to be executed for sms if any of Access Control Rules is applied. Possible values: accept, reject
  		sms_action_false	string	Action to be executed for sms if none of Access Control Rules is applied. Possible values: accept, reject
  		access_control_rules	array	List of Access Control Rule Secure IDs
  parent_assigned_acls	acl	direction	string	Direction for ACL. Possible values: inbound, outbound, any
  		voice_action_true	string	Action to be executed for call if any of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		voice_action_false	string	Action to be executed for call if none of Access Control Rules is applied. Possible values: accept, reject403, reject503
  		sms_action_true	string	Action to be executed for sms if any of Access Control Rules is applied. Possible values: accept, reject
  		sms_action_false	string	Action to be executed for sms if none of Access Control Rules is applied. Possible values: accept, reject
  		access_control_rules	array	List of Access Control Rule Secure IDs
  transformations		direction	string	Direction for transformation: inbound, outbound, any
  		action	string	Action to be executed for transformation: rewrite_to, rewrite_from
  		operands	array	Value(s) to be used for "action"
  balance opt			integer	Current balance of the Partner
  address1			string	Partner address
  address2			string	Partner address
  city			string	Partner city
  zip			string	Partner zip code
  country_code			string	Partner country ISO 3166-1 alpha-3 code
  prepay_amount			integer	Charge amount for prepay customers
  charge_at			integer	Balance value when prepay account will be charged
  payment_type			string	Type of payment. Posible values: prepay postpay

  
  

Billing Methods

The call will register the billing method for a particular customer. The mandatory fields are type, cc_number, name, cc_expiration, zip, country_code, phonenumber if applicable. When registering a credit card, the credit card number is shown only in the request, and is not fully returned as plain text in the response. Ensure the provided zip code is the existing one. The system will return error otherwise.

The call will register the billing method for a particular customer. The mandatory fields are type, cc_number, name, cc_expiration, zip, country_code, phonenumber.

Sample URL

curl -X GET --header 'Accept: application/json' -d '{"type":"visa", "cc_number":"4444444444445555", "cc_expiration":"092016", "cc_cid":"5569", "ec_account_number":"01564789987654", "name":"HG455", "address1":"90207 USA", "address2":"Colebrook Way bld 16", "city":"Stockton", "state":"CA", "zip":"90270", "country_code":"USA", "phone":"18004501575" }' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/partners/3b2e9fe7-e22e-4f03-8886-b5a84f851a6a/billing_method'

Parameters

Sample Response

 {
  "type": "visa",
  "cc_number": "4444",
  "cc_expiration": "092016",
  "name": "HG445",
  "address1": "90207 USA",
  "address2": "Colebrook Way bld 16",
  "city": "Stockton",
  "state": "CA",
  "zip": "90270",
  "country_code": "USA",
  "phone": "18004501575"
}

Attributes

The call will return information registered for the selected partner.

Sample URL

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/partners/3b2e9fe7-e22e-4f03-8886-b5a84f851a6a/billing_method'

Parameters

Sample Response

 {
  "type": "visa",
  "cc_number": "4444",
  "cc_expiration": "092016",
  "name": "HG445",
  "address1": "90207 USA",
  "address2": "Colebrook Way bld 16",
  "city": "Stockton",
  "state": "CA",
  "zip": "90270",
  "country_code": "USA",
  "phone": "18004501575"
}

Attributes

This call will remove billing method of the partner whose secure ID is specified. When completed, no billing method will be registered for the specified partner.

Sample URL

curl -X DELETE --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/partners/a771afc7-8856-4bd7-b24d-1cc3bcd1273c/billing_method'

Parameters

OAuth

This call will terminate your session.

Sample URL

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

This will terminate session of the partner whose token is specified.

Sample URL

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

Parameters

This call generates the token for a partner upon request.

Sample URL

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -u [your_user_name]:[your_password] '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'

Parameters

Sample Response

 {
"access_token": "8bfd6c6d-6291-488a-bed1-8784c195ce87",
"token_type": "bearer",
"refresh_token": "ed07dcd6-dfc5-4d7b-b7b4-891441371b3e",
"expires_in": 599,
"scope": "trust"
}

Attributes

Shows tokens for the logged in partner that haven’t yet been expired.

Sample URL

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

Sample Response

 {
   "access_token": "8bfd6c6d-6291-488a-bed1-8784c195ce87",
   "token_type": "bearer",
   "refresh_token": "ed07dcd6-dfc5-4d7b-b7b4-891441371b3e",
   "expires_in": 461,
   "scope": "trust"
}

Attributes

The call will return the currently logged in partner.

Sample URL

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

Sample Response

 {
"name": "ROOT",
"login": "carrierx",
"partner_sid": "c9Ua99icuPdvDvv2kvlNaPzMLDXwuEYJ",
"parent_sid": null
}

Attributes

Endpoints

Shows the list of existing Endpoints. If no filter is specified, the number of displayed items will be limited by the limit and offset values only. If the number of items exceeds the limit value, the has_more value in the response will be set to true, pagination field will suggest moving either to the next page or the previous one.
You may obtain the list of endpoints of a particular type by setting the filter for type value.

Alongside with the items, the GET request will also return the following information:

{
  "offset": 0,
  "limit": 10,
  "count": 10,
  "total": 541,
  "has_more": true,
  "pagination": {
      "next": "https://api.carrierx.com/core/v2/endpoints?limit=10&offset=10"
  },

Sample URL

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/endpoints?filter=capacity%20ne%200&order=type'

Parameters

Sample Response (type = third_party)

 {
    "endpoint_sid": "9fbfee56-5ded-4e65-a22c-697cd0331c16",
    "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
    "name": "Endpoint_name",
    "type": "third_party",
    "voip_token": null,
    "capacity": 0,
    "addresses": [
        {
            "ip": "162.251.181.136",
            "port": 5060,
            "direction": "any",
            "transport": "udp"
        },
        {
            "ip": "162.251.183.11",
            "port": 5060,
            "direction": "any",
            "transport": "udp"
        },
        {
            "ip": "12.7.192.27",
            "port": 5060,
            "direction": "any",
            "transport": "udp"
        }
    ],
    "attributes": {},
    "transformations": []
}

Sample Response (type = system_gateway)

 {
   {
          "endpoint_sid": "ad4e17aa-6ced-4925-8fd1-a3824bbfabf2",
          "partner_sid": "c9Ua99icuPdvDvv2kvlNaPzMLDXwuEYJ",
          "name": "N/A",
          "type": "system_gateway",
          "voip_token": null,
          "capacity": 0,
          "addresses": [
              {
                  "ip": "2.2.22.2",
                  "port": 5060,
                  "transport": "udp"
              }
          ],
          "attributes": {},
          "transformations": []
      }

Sample Response (type = mediator)

 {
  "endpoint_sid": "ded7064b-8240-457b-b167-081b1d8088ff",
  "partner_sid": "6bd4239b-e8e9-4d8d-a715-072810fb0ed5",
  "name": "2stage",
  "type": "mediator",
  "voip_token": "82de7c48-6e26-48c4-b3d1-891978e51802",
  "capacity": 0,
  "addresses": [
    {
      "ip": "12.7.192.202",
      "port": 5060,
      "transport": "udp"
    },
    {
      "ip": "12.7.192.203",
      "port": 5060,
      "transport": "udp"
    }
  ],
  "attributes": {
    "api_url": 'https://api.carrierx.com/mediator/v1/",
    "login": "VVP_01_mediator_159",
    "password": "BILiiZVBg3Qv",
    "account_sid": "088d9d0f-5fba-43df-82e2-92709596c9d0"
  }
  "transformations": [
    {
      "direction": "outbound",
      "action": "rewrite_from",
      "operands": [
          "14564423",
          "22224567"
      ]
    }
  ]
}

Sample Response (type = conference)

 {
  "endpoint_sid": "976b48e4-8ef1-4c08-94e2-d0c42a06c15a",
  "partner_sid": "6bd4239b-e8e9-4d8d-a715-072810fb0ed5",
  "name": "conference",
  "type": "conference",
  "voip_token": "cce86a5e-a506-471c-b833-1179167958b4",
  "capacity": 0,
  "addresses": [
      {
          "ip": "10.2.111.72",
          "port": 5060,
          "transport": "udp"
      }
  ],
  "attributes": {
      "api_url": 'https://api.carrierx.com/conference/v1",
      "did_group_id": "106",
      "login": "VVP_01_conference_207",
      "subscriber_sid": "N7HM94Wi5-dLHfTukcZBJqUpl7Off1X1",
      "password": "nkLs7ODSOvnF"
  },
  "transformations": [
      {
          "direction": "outbound",
          "action": "rewrite_to",
          "operands": [
              "4242",
              "180045651222"
          ]
      }
  ]
}

Sample Response (type = flexml)

 {
  "endpoint_sid": "b8c38808-d0ce-4a88-99ef-39b74a79ed9c",
  "partner_sid": "1dd7c274-210d-414a-911d-e6b920e06d63",
  "name": "jan17_pv",
  "type": "flexml",
  "voip_token": "38ba4bfe-b3f2-4031-bce4-01f0ee991595",
  "capacity": 0,
  "addresses": [
       {
          "ip": "10.222.2.197",
          "port": 5060,
          "transport": "udp"
       }
   ],
   "attributes": {
          "api_url": 'https://api.carrierx.com/flexml/v1",
          "login": "jan17_prog_voice_498",
          "password": "jV6zwrB0kZ5J",
          "account_sid": "9b33245f-27c2-48e6-bf7f-25af725a0eda"
    },
   "transformations": []
}

Note: If you search for a particular endpoint, you may narrow down your search by filtering items by any of the inner fields (for example, IP address):

Sample URL

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/endpoints?offset=0&limit=10&filter=addresses.ip%20eq%20%22162.251.181.136%22'

Sample Response

{
  "endpoint_sid": "9fbfee56-5ded-4e65-a22c-697cd0331c16",
  "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
  "name": "Core Endpoint",
  "type": "system_gateway",
  "voip_token": null,
  "capacity": 0,
  "addresses": [
      {
          "ip": "162.251.181.136",
          "port": 5060,
          "direction": "any",
          "transport": "udp"
      }
  ],
  "attributes": {},
  "transformations": []
}

Attributes

This call creates a new endpoint. The mandatory fields are ip and type. port if not defined will be set to default value 5060. name if not provided will be set to N/A and can be modified later on with PATCH call.

Sample URL for third party endpoint (type = third_party)

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

Sample URL for Mediator endpoint (type = mediator)

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"name":"2stage", "type":"mediator"}' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/endpoints'

Sample URL for Conference endpoint (type = conference)

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"name":"wyde_conf_EP", "type":"conference"}' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/endpoints'

Sample URL for FlexML endpoint (type = flexml)

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"name":"flexml", "type":"flexml"}' -u [your_user_name]:[your_password] https://api.carrierx.com/core/v2/endpoints

 {
  "endpoint_sid": "dc0b2da4-8679-484b-b7c3-7d7a4d11df15",
  "partner_sid": "6bd4239b-e8e9-4d8d-a715-072810fb0ed5",
  "name": "EP_Т_1",
  "type": "third_party",
  "voip_token": "d02f37bf-286f-46e0-ad7e-22260e46a405",
  "capacity": 0,
  "addresses": [
      {
          "ip": "1.1.2.13",
          "port": 5060,
          "direction": "any",
          "transport": "udp"
      }
  ],
  "attributes": {},
  "transformations": []
}

 {
  "endpoint_sid": "ded7064b-8240-457b-b167-081b1d8088ff",
  "partner_sid": "6bd4239b-e8e9-4d8d-a715-072810fb0ed5",
  "name": "2stage",
  "type": "mediator",
  "voip_token": "82de7c48-6e26-48c4-b3d1-891978e51802",
  "capacity": 0,
  "addresses": [
      {
          "ip": "12.7.192.202",
          "port": 5060,
          "transport": "udp"
      },
      {
          "ip": "12.7.192.203",
          "port": 5060,
          "transport": "udp"
      }
  ],
  "attributes": {
      "api_url": 'https://api.carrierx.com/mediator/v1",
      "login": "VVP_01_mediator_159",
      "password": "BILiiZVBg3Qv",
      "account_sid": "088d9d0f-5fba-43df-82e2-92709596c9d0"
  },
  "transformations": []
}

 {
  "endpoint_sid": "c32dd688-beaa-4a2f-817f-e30cb7152ffa",
  "partner_sid": "6bd4239b-e8e9-4d8d-a715-072810fb0ed5",
  "name": "wyde_conf_EP",
  "type": "conference",
  "voip_token": "2cc5b4cb-bde1-4a09-9a5e-82d8d70aa593",
  "capacity": 0,
  "addresses": [
      {
          "ip": "10.2.111.72",
          "port": 5060,
          "transport": "udp"
      }
  ],
  "attributes": {
      "did_group_id": "110",
      "api_url": 'https://api.carrierx.com/conference/v1",
      "subscriber_sid": "hPIj91cXDvdMxLLsmWglp5a4iB6yW-k1",
      "login": "VVP_01_conference_870",
      "password": "i9YNsm3bp5Do"
  },
  "transformations": []
}

{
  "endpoint_sid": "b0e5260b-b256-4263-9baa-fd9b81237257",
  "partner_sid": "ypdm9zW2d-f3rH.mljbilExkNXL2Zi5x",
  "name": "flexml",
  "type": "flexml",
  "voip_token": "9f0f25a1-97b4-4da3-a475-e6c1d21610c2",
  "capacity": 0,
  "addresses": [
      {
          "ip": "10.222.2.197",
          "port": 5060,
          "transport": "udp"
      }
  ],
  "attributes": {
      "api_url": 'https://api.carrierx.com/flexml/v1",
      "login": "carrierx_test_flexml_551",
      "password": "8R5o33nPS1Li",
      "account_sid": "9c7dfcba-f3c7-483e-b4fa-eea40cc1bce3"
  },
  "transformations": []
}

curl -X DELETE --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/endpoints/J0x698QJYfd9UNlAZ8Qkl0U4Pf6xazvv'

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/endpoints/00bf8b25-1e20-4f80-8529-8448df32d71a'

 {
  "endpoint_sid": "00bf8b25-1e20-4f80-8529-8448df32d71a",
  "partner_sid": "6bd4239b-e8e9-4d8d-a715-072810fb0ed5",
  "name": "3rdParty",
  "type": "third_party",
  "voip_token": "ab72ad7a-568b-466e-9fd9-407de0313e36",
  "capacity": 0,
  "addresses": [
      {
          "ip": "1.1.2.2",
          "port": 5060,
          "direction": "any",
          "transport": "udp"
      },
      {
          "ip": "2.2.2.3",
          "port": 5060,
          "direction": "any",
          "transport": "udp"
      }
  ],
  "attributes": {},
  "transformations": []
}

curl -X PATCH --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"addresses": [{"ip": "15.1.12.6", "port": "5060"}]}' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/endpoints/00bf8b25-1e20-4f80-8529-8448df32d71a'

{
  "endpoint_sid": "00bf8b25-1e20-4f80-8529-8448df32d71a",
  "partner_sid": "6bd4239b-e8e9-4d8d-a715-072810fb0ed5",
  "name": "3rdParty",
  "type": "third_party",
  "voip_token": "ab72ad7a-568b-466e-9fd9-407de0313e36",
  "capacity": 0,
  "addresses": [
      {
          "ip": "15.1.12.6",
          "port": 5060,
          "direction": "any",
          "transport": "udp"
      },
      {
          "ip": "1.1.2.2",
          "port": 5060,
          "direction": "any",
          "transport": "udp"
      },
      {
          "ip": "2.2.2.3",
          "port": 5060,
          "direction": "any",
          "transport": "udp"
      }
  ],
  "attributes": {},
  "transformations": []
}

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"endpoint_sid": "00bf8b25-1e20-4f80-8529-8448df32d71a", "partner_sid": "6bd4239b-e8e9-4d8d-a715-072810fb0ed5", "name": "3rdParty", "type": "third_party", "voip_token": "ab72ad7a-568b-466e-9fd9-407de0313e36", "capacity": 0, "addresses": [ {"ip": "1.1.2.2", "port": 5060, "transport": "udp" }, {"ip": "2.2.2.3", "port": 5060, "transport": "udp" } ], "attributes": {}, "transformations": []}" -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/endpoints/00bf8b25-1e20-4f80-8529-8448df32d71a'

 {
  "endpoint_sid": "00bf8b25-1e20-4f80-8529-8448df32d71a",
  "partner_sid": "6bd4239b-e8e9-4d8d-a715-072810fb0ed5",
  "name": "3rdParty",
  "type": "third_party",
  "voip_token": "ab72ad7a-568b-466e-9fd9-407de0313e36",
  "capacity": 0,
  "addresses": [
      {
          "ip": "1.1.2.2",
          "port": 5060,
          "direction": "any"
          "transport": "udp"
      },
      {
          "ip": "2.2.2.3",
          "port": 5060,
          "direction": "any"
          "transport": "udp"
      }
  ],
  "attributes": {},
  "transformations": []
}

 {
  "offset": 0,
  "limit": 10,
  "count": 10,
  "total": 541,
  "has_more": true,
  "pagination": {
      "next": "https://api.carrierx.com/core/v2/trunk_groups?limit=10&offset=10"
  },

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/trunk_groups?with_trunks=true&offset=0&limit=10'

  {
  "trunk_group_sid": "d47bc93e-64a1-4726-9131-e5f0accb4e0a",
  "name": "pqa_03a",
  "partner_sid": "4710877d-ce91-41eb-a96d-f487d547d2b1",
  "routing_type": "failover",
  "routing_data": null,
  "soft_failure_cooldown": 120,
  "soft_failure_codes": "408;",
  "acls": [
    {
       "direction": "outbound",
       "voice_action_true": null,
       "voice_action_false": "reject503",
       "sms_action_true": null,
       "sms_action_false": null,
       "access_control_rules": [
           "e214f6ab-7184-425b-85a9-7991e598ae72",
           "5b76b65c-259f-46f4-b083-7d0c3d3c4de4"
       ]
   },
   {
       "direction": "outbound",
       "voice_action_true": null,
       "voice_action_false": "accept",
       "sms_action_true": null,
       "sms_action_false": null,
       "access_control_rules": [
          "2c36804d-6e93-40c3-959d-8f59ab43e03c",
          "fea69a86-aa25-4797-8826-7bb695d0d498"
      ]
    }
  ],
  "trunks": [
    {
      "name": "tr1",
      "codec": null,
      "trunk_sid": "c41f7a3c-e5c9-4fb9-835f-8423497edf20",
      "endpoint_sid": null,
      "in_capacity": 0,
      "out_capacity": 0,
      "call_type": "regular",
      "transformations": [],
  "transformations": [
    {
      "direction": "outbound",
      "action": "rewrite_from",
      "operands": [
          "45611",
          "15601213322"
      ]
    }
  ]
}

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/endpoints?offset=0&limit=10&filter=addresses.ip%20eq%20%22162.251.181.136%22'

  {
    "offset": 0,
    "limit": 10,
    "count": 1,
    "total": 1,
    "has_more": false,
    "pagination": {},
    "items": [
        {
            "endpoint_sid": "9fbfee56-5ded-4e65-a22c-697cd0331c16",
            "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
            "name": "Core Endpoint",
            "type": "system_gateway",
            "voip_token": null,
            "capacity": 0,
            "addresses": [
                {
                    "ip": "162.251.181.136",
                    "port": 5060,
                    "direction": "any",
                    "transport": "udp"
                }
            ],
            "attributes": {},
            "transformations": []
        }
    ]
}

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d "{"name":"New Trunk Group", "trunks":[{"name": "Trunk1", "endpoint_sid": ""}]}" -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/trunk_groups?with_trunks=true'

 {
  "trunk_group_sid": "503167ea-b8a5-4a5d-97e3-d684884da1d8",
  "name": "New Trunk Group",
  "partner_sid": "ypdm9zW2d-f3rH.mljbilExkNXL2Zi5x",
  "routing_type": "failover",
  "routing_data": null,
  "soft_failure_cooldown": 120,
  "soft_failure_codes": "408;",
  "acls": [],
  "trunks": [
      {
          "trunk_sid": "fd97153a-e466-4de6-9484-c3d4dde72b85",
          "name": "Trunk1",
          "endpoint_sid": null,
          "in_capacity": 0,
          "out_capacity": 0,
          "call_type": "regular",
          "codec": null,
          "transformations": []
      }
  ],
  "transformations": []
}

curl -X DELETE --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/trunk_groups/s6Da94-oxPcGxCGlvsPFuST-o3umYCMr'

curl -X GET --header 'Accept: application/json' -u : 'https://api.carrierx.com/core/v2/trunk_groups/.vwm9yyV4ffsttLGxndm4wuKiXc82.-h?with_trunks=true"
Make request

 {
  "trunk_group_sid": ".vwm9yyV4ffsttLGxndm4wuKiXc82.-h",
  "name": "TrunkGroup8",
  "partner_sid": "ypdm9zW2d-f3rH.mljbilExkNXL2Zi5x",
  "routing_type": "failover",
  "routing_data": null,
  "soft_failure_cooldown": 120,
  "soft_failure_codes": "408;",
  "acls": [],
  "trunks": [],
  "transformations": []
}

curl -X PATCH --header 'Content-Type: application/json' --header 'Accept: application/json' -d "{"transformations": [ { "direction": "outbound", "action": "rewrite_from", "operands": [ "9999", "18662911805" ] }]}" -u : https://api.carrierx.com/core/v2/trunk_groups/bOUF99CmufeCwMPanRThYPBayANjvbRL'

 {
  "trunk_group_sid": "bOUF99CmufeCwMPanRThYPBayANjvbRL",
  "name": "TrunkGroup4",
  "partner_sid": "ypdm9zW2d-f3rH.mljbilExkNXL2Zi5x",
  "routing_type": "failover",
  "routing_data": null,
  "soft_failure_cooldown": 120,
  "soft_failure_codes": "408;",
  "acls": [],
  "transformations": [
      {
          "direction": "outbound",
          "action": "rewrite_from",
          "operands": [
              "9999",
              "18662911805"
          ]
      }
  ]
}

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d "{ "trunk_group_sid": "bOUF99CmufeCwMPanRThYPBayANjvbRL\", "name": "TrunkGroup4", "partner_sid": "ypdm9zW2d-f3rH.mljbilExkNXL2Zi5x", "routing_type": "failover", "routing_data": null, "soft_failure_cooldown": 120, "soft_failure_codes": "408;", "acls": [], "transformations": [ { "direction": "outbound", "action": "rewrite_from", "operands": [ "9999", "18662911805" ] } ] }" -u : 'https://api.carrierx.com/core/v2/trunk_groups/bOUF99CmufeCwMPanRThYPBayANjvbRL'

 {
  "trunk_group_sid": "bOUF99CmufeCwMPanRThYPBayANjvbRL",
  "name": "TrunkGroup4",
  "partner_sid": "ypdm9zW2d-f3rH.mljbilExkNXL2Zi5x",
  "routing_type": "failover",
  "routing_data": null,
  "soft_failure_cooldown": 120,
  "soft_failure_codes": "408;",
  "acls": [],
  "transformations": [
      {
          "direction": "outbound",
          "action": "rewrite_from",
          "operands": [
              "9999",
              "18662911805"
          ]
      }
  ]
}

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/trunk_groups/cd143163-a22a-4e54-9348-a5e4a6d5d396/trunks?offset=0&limit=10'

 {
          "name": "Trunk_0516_04_1",
          "codec": null,
          "trunk_sid": "15927485-7a3a-4abf-80cf-98dd2cd1d8d2",
          "endpoint_sid": null,
          "in_capacity": 0,
          "out_capacity": 0,
          "call_type": "regular",
          "transformations": []
      }

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"name": "trunk01", "endpoint_sid": null}' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/trunk_groups/f3893c2c-90d2-46f5-917a-5dba613cab6d/trunks'

 {
  "name": "trunk01",
  "codec": null,
  "trunk_sid": "048eacb0-cfde-4755-b289-83be79011e45",
  "endpoint_sid": null,
  "in_capacity": 0,
  "out_capacity": 0,
  "call_type": "regular",
  "transformations": []
}

curl -X DELETE --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/trunk_groups/188b8e36-728d-48f9-a253-2326352b85f5/trunks/mtid9.iwlPeZ7EU7ABGOHP4ieMStx.nl”

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/trunk_groups/f3893c2c-90d2-46f5-917a-5dba613cab6d/trunks/21efab69-ded1-4c71-adbe-10584587189c'

 {
  "name": "tr1",
  "codec": null,
  "trunk_sid": "21efab69-ded1-4c71-adbe-10584587189c",
  "endpoint_sid": "601f0f9b-759f-485f-bc45-d1f919e8cab3",
  "in_capacity": 0,
  "out_capacity": 0,
  "call_type": "regular",
  "transformations": []
}

curl -X PATCH --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"name": "trunk_new_name", "endpoint_sid": null}" -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/trunk_groups/f3893c2c-90d2-46f5-917a-5dba613cab6d/trunks/21efab69-ded1-4c71-adbe-10584587189c'

 {
  "name": "trunk_new_name",
  "codec": null,
  "trunk_sid": "21efab69-ded1-4c71-adbe-10584587189c",
  "endpoint_sid": "601f0f9b-759f-485f-bc45-d1f919e8cab3",
  "in_capacity": 0,
  "out_capacity": 0,
  "call_type": "regular",
  "transformations": []
}

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ "name": "trunk_new_name", "codec": null, "trunk_sid": "21efab69-ded1-4c71-adbe-10584587189c", "endpoint_sid\": "601f0f9b-759f-485f-bc45-d1f919e8cab3", "in_capacity": 0, "out_capacity": 0, "call_type": "regular", "transformations": [] }' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/trunk_groups/f3893c2c-90d2-46f5-917a-5dba613cab6d/trunks/21efab69-ded1-4c71-adbe-10584587189c'

 {
  "name": "trunk_new_name",
  "codec": null,
  "trunk_sid": "21efab69-ded1-4c71-adbe-10584587189c",
  "endpoint_sid": "601f0f9b-759f-485f-bc45-d1f919e8cab3",
  "in_capacity": 0,
  "out_capacity": 0,
  "call_type": "regular",
  "transformations": []
}

 {
  "offset": 0,
  "limit": 10,
  "count": 10,
  "total": 541,
  "has_more": true,
  "pagination": {
      "next": "https://api.carrierx.com/core/v2/dids?limit=10&offset=10"
  }

curl -X GET --header 'Accept: application/json' –u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/dids?offset=0&limit=10&filter=trunk_group_sid%20ne%20null'

{
  "did_sid": "1b653875-01f0-4219-8f85-bba8d142bacb",
  "phonenumber": "15162065290",
  "in_country_format": "(516) 206-5290",
  "international_format": "+1 516-206-5290",
  "capabilities": 7,
  "country_code": "USA",
  "state": null,
  "locality": null,
  "price": "0.6",
  "partner_sid": "8ced9c69-da68-4bf0-96c3-eb95eec2b95c",
  "trunk_group_sid": "8c8735ed-e69c-4748-be8b-d22d744baa69",
  "callback_url": null,
  "attributes": {},
  "transformations": []
}

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"phonenumber":"15187778065", "callback_url":""}' 'https://api.carrierx.com/core/v2/dids'

{
    "did_sid": "d5b7cf92-2fb2-4e27-abcb-d345a4137161",
    "phonenumber": "16507951052",
    "in_country_format": "(650) 795-1052",
    "international_format": "+1 650-795-1052",
    "capabilities": 7,
    "country_code": "USA",
    "state": "CA",
    "locality": null,
    "price": "0.6",
    "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
    "trunk_group_sid": "1b6f6a1d-de00-4520-b443-38ceb521f2ed",
    "callback_url": null,
    "attributes": {},
    "transformations": []
}

curl -X DELETE --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/dids/fMDS950WI-eD6UJSLM2nnqDD4Q1vkEod'

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/dids/d5b7cf92-2fb2-4e27-abcb-d345a4137161'

{
    "did_sid": "d5b7cf92-2fb2-4e27-abcb-d345a4137161",
    "phonenumber": "16507951052",
    "in_country_format": "(650) 795-1052",
    "international_format": "+1 650-795-1052",
    "capabilities": 7,
    "country_code": "USA",
    "state": "CA",
    "locality": null,
    "price": "0.6",
    "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
    "trunk_group_sid": "1b6f6a1d-de00-4520-b443-38ceb521f2ed",
    "callback_url": null,
    "attributes": {},
    "transformations": []
}

curl -X PATCH --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"attributes":{"attribute1":"value1"}}' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/dids/8oD290nJavb2kJX4d8hV.hcP.AO3Xcn.'

{
    "did_sid": "d5b7cf92-2fb2-4e27-abcb-d345a4137161",
    "phonenumber": "16507951052",
    "in_country_format": "(650) 795-1052",
    "international_format": "+1 650-795-1052",
    "capabilities": 7,
    "country_code": "USA",
    "state": "CA",
    "locality": null,
    "price": "0.6",
    "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
    "trunk_group_sid": "1b6f6a1d-de00-4520-b443-38ceb521f2ed",
    "callback_url": null,
    "attributes": {},
    "transformations": []
}

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d ' {"did_sid": "8oD290nJavb2kJX4d8hV.hcP.AO3Xcn.", "phonenumber": "15187778065", "in_country_format": "(518) 777-8065", "international_format": "+1 518-777-8065", "capabilities": 7, "country_code": "USA", "state": "NY", "locality": null, "price": "0.6", "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee", "trunk_group_sid": null, "callback_url": null, "attributes": {}, "transformations": [] }' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/dids/8oD290nJavb2kJX4d8hV.hcP.AO3Xcn.'

{
    "did_sid": "d5b7cf92-2fb2-4e27-abcb-d345a4137161",
    "phonenumber": "16507951052",
    "in_country_format": "(650) 795-1052",
    "international_format": "+1 650-795-1052",
    "capabilities": 7,
    "country_code": "USA",
    "state": "CA",
    "locality": null,
    "price": "0.6",
    "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
    "trunk_group_sid": "1b6f6a1d-de00-4520-b443-38ceb521f2ed",
    "callback_url": null,
    "attributes": {},
    "transformations": []
}

{
  "offset": 0,
  "limit": 10,
  "count": 10,
  "total": null,
  "has_more": true,
  "pagination": {
      "next": "https://api.carrierx.com/core/v2/dids/inventory?limit=10&offset=10"
  },

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/dids/inventory?offset=0&limit=10"

{
    "did_sid": "d5b7cf92-2fb2-4e27-abcb-d345a4137161",
    "phonenumber": "16507951052",
    "in_country_format": "(650) 795-1052",
    "international_format": "+1 650-795-1052",
    "capabilities": 7,
    "country_code": "USA",
    "state": "CA",
    "locality": null,
    "price": "0.6",
    "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
    "trunk_group_sid": "1b6f6a1d-de00-4520-b443-38ceb521f2ed",
    "callback_url": null,
    "attributes": {},
    "transformations": []
}

curl -X GET --header "Accept: application/json" --header -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/dids/inventory/c9Ua89icuONvDvs0kvlNaPzMLDXwuEYJ'

{
    "did_sid": "d5b7cf92-2fb2-4e27-abcb-d345a4137161",
    "phonenumber": "16507951052",
    "in_country_format": "(650) 795-1052",
    "international_format": "+1 650-795-1052",
    "capabilities": 7,
    "country_code": "USA",
    "state": "CA",
    "locality": null,
    "price": "0.6",
    "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
    "trunk_group_sid": "1b6f6a1d-de00-4520-b443-38ceb521f2ed",
    "callback_url": null,
    "attributes": {},
    "transformations": []
}

curl -X GET --header 'Accept: application/json' --header -u [your_user_name]:[your_password] https://api.carrierx.com/core/v2/dids/coverage?offset=0&limit=10&group_by=state'

  {
          "key": "IL",
          "count": 116
      },
      {
          "key": "MD",
          "count": 8
      },
      {
          "key": "CA",
          "count": 689
      }

This call performs a search of existing rates matching the defined criteria.

Sample URL

curl -X GET --header 'Accept: application/json' --header -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/dids/rates?offset=0&limit=10"

Parameters

Sample Response

 {
  "offset": 0,
  "limit": 10,
  "total": 10,
  "has_more": false,
  "partner_sid": "6bd4239b-e8e9-4d8d-a715-072810fb0ed5",
  "effective_date": "2016-01-01T00:00:00.000Z",
  "active": "yes",
  "pagination": {},
  "items": [
      {
          "prefix": 1565,
          "price": "1",
          "country_code": "USA"
      }
  ]
}

Attributes

This call will return the existing rates for the specified phone number.

Sample URL

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/dids/rates/18004561252?offset=0&limit=10"

Parameters

Sample Response

{
   "prefix": 180,
   "price": "1",
   "country_code": "USA"
}

Attributes

SMS

Shows the list of Message detailed reports (DRs) for inbound and outbound messages. If no filter is specified, the number of displayed items will be limited by the “limit”/”offset” values only. If the number of items exceeds the “limit” value, the “has_more”: in the response is set to “true”, and the “pagination” field suggests moving either to the next page or the previous one.

Sample URL

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/sms/message_drs?offset=0&limit=10'

Parameters

Sample Response

 {
    "dr_sid": "03fed25a-274d-4e9a-8120-1454c63f7b23",
    "version": null,
    "type": "sms",
    "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
    "direction": "outbound",
    "date_insert": "2018-04-11T10:45:00.000Z",
    "date_start": "2018-04-11T10:45:00.000Z",
    "date_stop": "2018-04-11T13:45:00.000Z",
    "status": "delivered",
    "mcc": 0,
    "mnc": 0,
    "message_segments": 1,
    "price": "0.005",
    "number_billing": "17208209039",
    "number_external": "79200207571",
    "number_src": "17208209039",
    "number_dst": "79200207571",
    "message": "test message"
 }

Attributes

This call will retrieve data for the single DR which secure ID is specified.

Sample URL

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/sms/message_drs/03fed25a-274d-4e9a-8120-1454c63f7b23'

Parameters

Sample Response

 {
    "dr_sid": "03fed25a-274d-4e9a-8120-1454c63f7b23",
    "version": null,
    "type": "sms",
    "partner_sid": "6feb0f8b-f104-4445-8db8-593c5e5cb7ee",
    "direction": "outbound",
    "date_insert": "2018-04-11T10:45:00.000Z",
    "date_start": "2018-04-11T10:45:00.000Z",
    "date_stop": "2018-04-11T13:45:00.000Z",
    "status": "delivered",
    "mcc": 0,
    "mnc": 0,
    "message_segments": 1,
    "price": "0.005",
    "number_billing": "17208209039",
    "number_external": "79200207571",
    "number_src": "17208209039",
    "number_dst": "79200207571",
    "message": "test message"
 }

Attributes

Shows the list of inbound and outbound messages. If no filter is specified, the number of displayed items will be limited by the limit and offset values only. If the number of items exceeds the limit value, the has_more value in the response will be set to true.

Sample URL

curl -X GET --header 'Accept: application/json' -u [your_user_name]:[your_password] 'https://api.carrierx.com/core/v2/sms/messages?offset=0&limit=10&filter=direction%20eq%20inbound'

Parameters

Sample Response

{
  "message_sid": "580e262d-6384-41bd-a50f-07325326a003",
  "partner_sid": "6bd4239b-e8e9-4d8d-a715-072810fb0ed5",
  "message": "Sent from your  trial account - Thanks for the message.",
  "direction": "inbound",
  "date_created": "2016-10-11T10:27:47.000Z",
  "date_status_changed": "2016-10-11T10:27:47.000Z",
  "from_did": "12039301099",
  "to_did": "17208209016",
  "status": "received",
  "mcc": null,
  "mnc": null,
  "message_segments": 2,
  "price": "0"
}

Attributes