Logo
Zoom Public API Documentation

Get an SMS campaign

GET {{baseUrl}}/phone/sms_campaigns/:smsCampaignId

Use this API to get a specific SMS campaign.

Prerequisites: * A Pro or higher account plan * A Zoom Phone license

Scopes: phone:read:admin

Granular Scopes: phone:read:sms_campaign:admin

Rate Limit Label: Light

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "id": "<string>", "display_name": "<string>", "status": "declined", "service_type": "contactCenter", "brand": { "id": "<string>", "name": "<string>" }, "phone_numbers": [ { "id": "<string>", "number": "<string>" }, { "id": "<string>", "number": "<string>" } ], "auto_renew": "<boolean>", "create_time": "<string>", "use_case": "lowVolumeMixed", "categories_fit": "<boolean>", "content_type": [ "urlLink", "urlLink" ], "sample_message_1": "<string>", "sample_message_2": "<string>", "sample_message_3": "<string>", "sample_message_4": "<string>", "sample_message_5": "<string>" }



Curl
curl -X GET 'https://api.zoom.us/v2/phone/sms_campaigns/:smsCampaignId' -H 'Accept: application/json'

ENDPOINTS