List messaging profiles

gethttps://api.telnyx.com/v2/messaging_profiles

List messaging profiles

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/messaging_profiles?page[number]=1&page[size]=20"

Parameters

In Query
page[number]
integer
(1)
optional
The page number to load
Default:
1
page[size]
integer
(1 - 250)
optional
The size of the page
Default:
20

Responses

200
Successful response with a list of messaging profiles.
default
Unexpected error

Success Response

{
  "data": {
    "created_at": "2019-01-23T18:10:02.574Z",
    "enabled": true,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Profile for Messages",
    "number_pool_settings": {
      "geomatch": false,
      "long_code_weight": 2,
      "skip_unhealthy": false,
      "sticky_sender": true,
      "toll_free_weight": 10
    },
    "record_type": "messaging_profile",
    "updated_at": "2019-01-23T18:10:02.574Z",
    "url_shortener_settings": {
      "domain": "example.ex",
      "prefix": "cmpny",
      "replace_blacklist_only": true,
      "send_webhooks": false
    },
    "v1_secret": "rP1VamejkU2v0qIUxntqLW2c",
    "webhook_api_version": "2",
    "webhook_failover_url": "https://backup.example.com/hooks",
    "webhook_url": "https://www.example.com/hooks",
    "whitelisted_destinations": [
      "US"
    ]
  },
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

...

posthttps://api.telnyx.com/v2/messaging_profiles

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/messaging_profiles/{id}

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/messaging_profiles/{id}

...

...

Parameters

Responses

Success Response

...

deletehttps://api.telnyx.com/v2/messaging_profiles/{id}

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/messaging_profiles/{id}/phone_numbers

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/messaging_profiles/{id}/short_codes

...

...

Parameters

Responses

Success Response

Was this page helpful?