Phone Numbers API - List Your Direct Orders

\Use this method to retrieve a list of all the direct orders of phone numbers you have initiated with TeleSign, so you can review the status and other details of each one.

Reference Page

GET /v1/phone_numbers/direct_orders

Request

GET /v1/phone_numbers/direct_orders HTTP/1.1
Authorization: Basic 12345678-9ABC-DEF0-1234-56789ABCDEF0:vjE/ZDfPvDkuGNsuqCFFO4neYIs=
Content-Type: application/x-www-form-urlencoded; charset=utf-8
Host: rest-ww.telesign.com

Response

{
  "pagination": {
    "page": 1,
    "total_pages": 1,
    "page_size": 10
  },
  "data": [
    {
      "order_id": "632a70h3-u893-48e2-jjl2-ou83k278yi28",
      "order_accepted_date": "2019-10-21T17:33:22.000Z",
      "status": "in progress",
      "last_date_modified": "2019-10-21T17:38:22.000Z",
      "country_iso2": "BE",
      "quantity": 4,
      "capabilities": {
        "sms": true,
        "voice": true
      },
      "numbers": [],
      "number_type": "mobile",
      "number_pattern": "324",
      "pattern_method": "prefix",
      "email": "[email protected]",
      "contact_name": "Ms Health Center Manager",
      "use_case": "Business notifications and reminders",
      "description": "Continuous numbers array preferred",
      "city": [
        "Antwerp",
        "Brussels"
      ],
      "partial_order_match": true
    },
    {
      "order_id": "632a70h3-u893-48e2-tn38-ou83k278yi93",
      "order_accepted_date": "2019-09-21T17:33:22.000Z",
      "status": "resolved",
      "last_date_modified": "2019-09-21T17:38:22.000Z",
      "country_iso2": "US",
      "quantity": 2,
      "capabilities": {
        "sms": true,
        "voice": true
      },
      "numbers": [
        "18004017890",
        "18664821930"
      ],
      "number_type": null,
      "number_pattern": null,
      "pattern_method": "prefix",
      "email": "[email protected]",
      "contact_name": "Numbers Acquisition Manager",
      "use_case": "Customers Help Desk",
      "description": "1800 or 1866 prefixes",
      "city": [
        "New York",
        "Chicago"
      ],
      "partial_order_match": null
    }
  ]
}

Try It

If you have been granted access and credentials for the Phone Numbers API and you have created at least one direct order, you can try a test request using this method in the Phone Numbers API Explorer. You can also get a code snippet for the request.

  1. Click the Auth tab and for Username add your Customer ID. For Password add your API key.
  2. Click Send.
  3. Click the Code Generation tab and use the Language and Library menus to choose the language you want your code snippet in.

📘

NOTE:

Create at least one direct order before trying out this feature, otherwise nothing is returned!


Did this page help you?