Sign in

v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
SMS

Get a carrier registration

Poll this for approval progress after starting a registration.

get/v1/sms/registrations/{id}

Path parameters

idstring required

Response

Registration

idstring
registrationType'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free'
status'pending' | 'approved' | 'rejected' | 'requested' | 'changes_requested' | 'deactivated'

requested/changes_requested = pre-submission review states; customers see them as pending / needs changes.

brandStatusstring
campaignStatusstring
declineReasonstring nullable
phoneNumbersstring[]
awaitingOtpboolean