List messaging hosted numbers

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const phoneNumberWithMessagingSettings of client.messagingHostedNumbers.list()) { console.log(phoneNumberWithMessagingSettings.id); }

{ "data": [ { "record_type": "messaging_settings", "id": "1293384261075731499", "phone_number": "+18005550001", "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "created_at": "2019-01-23T18:10:02.574Z", "updated_at": "2019-01-23T18:10:02.574Z", "country_code": "US", "type": "tollfree", "health": { "message_count": 122, "inbound_outbound_ratio": 0.43, "success_ratio": 0.94, "spam_ratio": 0.06 }, "eligible_messaging_products": [ "A2P" ], "traffic_type": "A2P", "messaging_product": "A2P", "features": { "sms": { "domestic_two_way": true, "international_inbound": true, "international_outbound": true }, "mms": null } } ], "meta": { "total_pages": 3, "total_results": 55, "page_number": 2, "page_size": 25 } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter[messaging_profile_id]

string<uuid>

Filter by messaging profile ID.

filter[phone_number]

string

Filter by exact phone number.

filter[phone_number][contains]

string

Filter by phone number substring.

sort[phone_number]

enum<string>

Sort by phone number.

Available options:

asc,

desc

page[number]

integer

default:1

Page number to retrieve (1-based).

page[size]

integer

default:20

Number of items to return per page.

Response

Successful response with a list of hosted numbers.

data

object[]

Show child attributes