Latest Legacy

    Check all existing orders

    This API lets you fetch all of your hosted messaging number orders.

    API Endpoint

    GET https://api.plivo.com/v1/Account/{auth_id}/HostedMessagingNumber<filters>

    Arguments

    hosted_messaging_number_idstringA unique identifier for the hosted messaging order.
    hosting_statusStatus of a hosted messaging number order.

    Allowed values:

    • new
    • in_review
    • processing
    • completed
    • failed
    aliasstringFriendly name for a hosted messaging number order.
    loa_idstringUnique identifier for the LOA.

    Returns

    A dictionary with an objects property that contains a list of up to limit hosted messaging numbers. Each tuple in the list is a separate HostedMessagingNumber object.

    Response

    HTTP Status Code: 200

    {
   "api_id":"f685a4da-4085-11ec-a1c3-0242ac110006",
   "meta_response":{
      "limit":20,
      "next":null,
      "offset":0,
      "previous":null,
      "total_count":1
   },
   "objects":[
      {
         "alias":"check-profile-number-profile-test-3",
         "application":"/v1/Account/MAXXXXXXXXXXXXXXXXXX/Application/43598296806979568/",
         "created_at":"2021-11-03T10:03:00.551378Z",
         "failure_reason":"",
         "hosted_messaging_number_id":"6bf51ca8-4d11-453c-57c3-09c42d949f92",
         "hosting_status":"COMPLETED",
         "loa_id":"b855aaf1-1b1d-443c-8a35-4cf65102e2ef",
         "number":"12142292386",
         "resource_uri":"/v1/Account/MAXXXXXXXXXXXXXXXXXX/HostedMessagingNumber/6bf51ca8-4d11-453c-57c3-09c42d949f92/"
      }
   ]
}

    1
2

    curl -i --user AUTH_ID:AUTH_TOKEN \
    https://api.plivo.com/v1/Account/{auth_id}/HostedMessagingNumber/