Want to provide feedback?

Write to docs@telesign.com.

Get the Status of a Direct Order

Once you create a direct order, it moves through several processing statuses (‘accepted’, ‘in progress’, ‘resolved’, ‘rejected’, ‘cancelled’). This method can be used to retrieve the current status as well as other details of a direct order you have created.

Reference Page

GET /direct_orders/{order_id}

Request
application/x-www-form-urlencoded
GET /v1/phone_numbers/direct_orders/632a70h3-u893-48e2-jjl2-ou83k278yi28 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
application/json
{
  "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": "resolved",
      "last_date_modified": "2019-10-21T17:40:22.000Z",
      "country_iso2": "BE",
      "quantity": 4,
      "capabilities": {
        "sms": true,
        "voice": true
      },
      "numbers": [
        "32460213960",
        "32460200563",
        "32460200562",
        "32460200561"
      ],
      "number_type": "mobile",
      "number_pattern": "324",
      "pattern_method": "prefix",
      "email": "HealthBelgium@gmail.com",
      "contact_name": "Ms Health Center Manager",
      "use_case": "Business notifications and reminders",
      "description": "Continuous numbers array preferred",
      "city": [
        "Antwerp",
        "Brussels"
      ],
      "partial_order_match": true
    }
  ]
}

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 below. 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. For Path Params enter the order ID for one of your direct orders.
  3. Click Send.
  4. Click the Code Generation tab and use the Language and Library menus to choose the language you want your code snippet in.
Phone Numbers API Explorer
NOTE: The response time shown is not indicative of regular transmission rates, and only applies to the Phone Numbers API Explorer.
Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
order_id
$$.env
No $$.env variables are being used in this request.

Next Steps

Check out some other related pages:

  • List Your Direct Orders - Learn how to use the Phone Numbers API to retreive a list of all previously created direct orders, including the status for each.
  • Cancel a Direct Order - Learn how to use the Phone Numbers API to cancel a specified direct order.