Skip to main content

Enums

Template_Category

ValueDescription
MARKETINGIt includes promotions or offers, updates or invites customers to respond/take action. Any use that does not conform to for utility or authentication purposes is marketing.
UTILITYIt facilitates a specific request or transaction agreed upon, or provide customers with updates related to transactions in progress, including post-sale notifications and periodic billing.
AUTHENTICATIONIt enables business to authenticate users using one-time passwords, which may occur in multiple steps of the login process. (e.g., account verification, account recovery, integrity challenges)

Template_Status

ValueDescription
APPROVEDAPPROVED.
PENDINGPENDING.
PENDING_DELETIONPENDING_DELETION.
DISABLEDDISABLED.
IN_APPEALIN_APPEAL.
REJECTEDREJECTED.
DELETEDDELETED.
PAUSEDPAUSED.
LIMIT_EXCEEDEDLIMIT_EXCEEDED.

Template_Quality_Score

ValueDescription
UNKNOWNUNKNOWN
GREENHIGH.
YELLOWMIDDLE.
REDLOW.

Message_Type

ValueDescription
texttext.
imageimage.
audioaudio.
videovideo.
documentdocument.
locationlocation.
stickersticker.
templatetemplate .

Phone_Status

ValueDescription
PENDINGPENDING.
DELETEDDELETED.
MIGRATEDMIGRATED.
BANNEDBANNED.
RESTRICTEDRESTRICTED.
RATE_LIMITEDRATE_LIMITED.
FLAGGEDFLAGGED.
CONNECTEDCONNECTED.
DISCONNECTEDDISCONNECTED.
UNKNOWNUNKNOWN.
UNVERIFIEDUNVERIFIED.

Phone_Name_Status

ValueDescription
APPROVEDThe name has been approved.
NONENo certificate available.
AVAILABLE_WITHOUT_REVIEWCertificates for phone numbers can be downloaded and display names can be used without auditing.
DECLINEDThe name has not been approved. You cannot download certificates.
EXPIREDYour certificate has expired and is no longer available for download.
PENDING_REVIEWYour name request is under review. You cannot download certificates.

Phone_Quality_Rating

ValueDescription
GREENHIGH.
YELLOWMIDDLE.
REDLOW.
UNKNOWNUNKNOWN.

Phone_Messaging_Limit

ValueDescription
TIER_1K1 thousand customers/24 hours.
TIER_10K10 thousand customers/24 hours.
TIER_100K100 thousand customers/24 hours.
TIER_5050 thousand customers/24 hours.
TIER_250250 thousand customers/24 hours.
TIER_UNLIMITEDUNLIMITED

Error_Code

ValueDescription
17100no valid channel.
17101create channel account failed.
17102channel account not found.
17103get register token failed.
17104get channel account failed.
17105get channel account phone list failed.
17106check code failed.
17107create template failed.
17108get templates failed.
17109delete template failed.
17110upload bad file.
17111upload template file failed.
17112upload media failed.
17113get media failed.
17114delete media failed.
17115send message failed.
17116get template failed.
17117upload file failed.
17118get conversation list failed.
17119get inbound analysis failed.
17120get outbound analysis failed.
17121get message list failed.
17122get message summary failed.
17123update template tag failed.