Profiles
List messaging profiles
get/messaging_profiles
Query parameters
Consolidated filter parameter (deepObject style). Originally: filter[name]
Consolidated page parameter (deepObject style). Originally: page[number], page[size]
filter[name][eq]string
Filter profiles by exact name match.
filter[name][contains]string
Filter profiles by name containing the given string.
Response
Successful response with a list of messaging profiles.
Example response
{
"data": [
{
"created_at": "2019-01-23T18:10:02.574Z",
"daily_spend_limit": "100.00",
"daily_spend_limit_enabled": false,
"enabled": true,
"health_webhook_url": null,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"mms_fall_back_to_sms": false,
"mms_transcoding": false,
"mobile_only": false,
"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",
"redaction_enabled": false,
"redaction_level": 2,
"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
}
}