Methods

Objects

Formats

Specific formats used for some values.

Format Description Regex
address_city City ^.{0,255}$
address_state State ^.{0,255}$
address_street Street name and number ^.{0,65535}$
address_zip ZIP Code ^.{0,10}$
amount amount in cents with 2 decimals. Example : "1000.00" for 10 USD or EUR ^[0-9]+\.[0-9]{2}$
amount_4 amount in cents with 4 decimals. Example : "1000.0000" for 10 USD or EUR ^[0-9]+\.[0-9]{4}$
app_name Limited to Unicode letters, numbers, parenthesis, space, dash and underscore ^[\pL0-9\(\) _-]{1,64}$
callid 64-bit unsigned integer ^[0-9]{1,19}$
cdr_customer_field 32 alphanumeric characters maximum ^[a-zA-Z0-9]{0,32}$
cli_phone_number International E.164 format "+CCNSN". Example: "+16467890800", "+447890123456", "+33678912345" or "BLOCKED" ^(BLOCKED|\+[1-9][0-9]{5,14})$
country_code ISO 3166-1 alpha-2 country code. Example: "US" ^[A-Z]{2}$
datetime YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00" ^2[0-9]{3}-[0-1][0-9]-[0-3][0-9] [0-2][0-9]:[0-5][0-9]:[0-5][0-9]$
datetime_iso YYYY-MM-DDTHH:MM:SSZ in UTC timezone. Example: "2012-04-24T23:42:00Z" or "2012-04-24T23:42:00+00:00" ^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](Z|+\d{2}:\d{2})$
datetime_ms YYYY-MM-DD HH:MM:SS.sss in UTC timezone. Example: "2012-04-24 23:42:00.123" ^2[0-9]{3}-[0-1][0-9]-[0-3][0-9] [0-2][0-9]:[0-5][0-9]:[0-5][0-9].\d{3}$
datetime_ms_iso YYYY-MM-DDTHH:MM:SS.sssZ in UTC timezone. Example: "2012-04-24T23:42:00.123Z" or "2012-04-24T23:42:00.123+00:00" ^2[0-9]{3}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9].\d{3}(Z|+\d{2}:\d{2})$
dial_timeout Must be between 5 and 300 seconds ^\d{1,3}$
email An email address ^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,63}$
field_name Generic name field ^.{1,64}$
hash Unique object identifier ^[A-Z0-9]{8}$
hid Unique object identifier ^[a-zA-Z0-9]{32}$
http_basic_auth login:password used for Basic HTTP Authentication ^.+:.+$
locale POSIX/IANA locale code. Example: "en_US" or "fr_FR". ^[a-z]{2}_[A-Z]{2}$
media_library_name Unicode letters, parenthesis, dot, plus, star, numbers, dash, space, hash ^[\pL\(\)\.\+\*,0-9# -]+$
phone_number International E.164 format "+CCNSN". Example: "+16467890800", "+447890123456", or "+33678912345" ^\+[1-9][0-9]{5,14}$
ring_timeout Must be between 5 and 120 seconds ^\d{1,3}$
rt_conference_id Conference ID ^[0-9A-Za-z]{1,32}$
rt_media Media ID (int) or Text-to-Speech "TTS|TTS_EN-GB_DANIEL|Text to say" ^(TTS\|([0-9A-Z_-]+)\|(.+)|[1-9][0-9]+)$
sip_subscriber_username SIP Subscriber username ^[a-z0-9]{4,32}$
sms_sender a-zA-Z0-9, space, dash, underscore - must contain at least one alpha character ^[ a-zA-Z0-9_-]+$
subaccount_password_value Sub Account password ^.{10,255}$
timezone_str IANA timezone name. Example: "Europe/Paris". ^[a-zA-Z_+-]+(?:\/[a-zA-Z0-9_+-]+)?$
url HTTP(S) URL ^https?:\/\/(?:.+:.+@)?(?:[a-z0-9\.\-]+\.[a-z]{2,6}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})(?::[1-9][0-9]+)?(?:\/.*)?$
vms_file_name Voicemail Recording Attachement filename. Use these tags to name the file. Example: "{CALLID}-{MEDIA_HASH}" or "{DATETIME}-{CALLID}" ^\{(DATETIME|MEDIA_HASH|CALLID)\}(-\{(DATETIME|MEDIA_HASH|CALLID)\}){0,}$