{
"version": 1,
"methods": {
"addMemberToConference": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "member",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "4234"
}
}
]
},
"getBalance": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "balance",
"shape": {
"kind": "object",
"fields": [
{
"name": "current_balance",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "112.192790"
}
},
{
"name": "spent_total",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "21.05321"
}
},
{
"name": "calls_total",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2788"
}
},
{
"name": "time_total",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "10:17:48"
}
},
{
"name": "spent_today",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.1205"
}
},
{
"name": "calls_today",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5"
}
},
{
"name": "time_today",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "10:50"
}
}
]
}
}
]
},
"getConference": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "conference",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "conference",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1599"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "testing"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "testing conference"
}
},
{
"name": "max_members",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "sound_join",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_leave",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_has_joined",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_has_left",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_kicked",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_muted",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_unmuted",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_only_person",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_only_one",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_there_are",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_other_in_party",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_place_into_conference",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_get_pin",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_invalid_pin",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_locked",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_locked_now",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_unlocked_now",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_error_menu",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_participants_muted",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "sound_participants_unmuted",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "language",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "en"
}
},
{
"name": "members",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "30;31;32"
}
}
]
}
}
}
]
},
"getConferenceMembers": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "members",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "member",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1599"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "testing"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "testing description"
}
},
{
"name": "pin",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1234"
}
},
{
"name": "announce_join_leave",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "admin",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "start_muted",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "announce_user_count",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "announce_only_user",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "moh_when_empty",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "guitar_alchemy"
}
},
{
"name": "quiet",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "announcement",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "drop_silence",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "talking_threshold",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "140"
}
},
{
"name": "silence_threshold",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2500"
}
},
{
"name": "talk_detection",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "jitter_buffer",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
}
]
}
}
}
]
},
"getConferenceRecordings": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "recordings",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1234567890"
}
},
{
"name": "recording",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1543338379"
}
},
{
"name": "conference",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1234"
}
},
{
"name": "duration",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "6"
}
},
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2018-11-27 12:06:19"
}
}
]
}
}
}
]
},
"getConferenceRecordingFile": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "recording",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "recording",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1543338379"
}
},
{
"name": "data",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "UklGRqTEAQBXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YYDEA...."
}
}
]
}
}
}
]
},
"getCountries": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "countries",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "CA"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Canada"
}
}
]
}
}
}
]
},
"getIP": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "ip",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "174.132.203.114"
}
}
]
},
"getLanguages": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "languages",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "en"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "English"
}
}
]
}
}
}
]
},
"getLocales": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "locales",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ar-EG"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Arabic (Egypt), modern standard"
}
}
]
}
}
}
]
},
"getServersInfo": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "servers",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "server_name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Houston, TX"
}
},
{
"name": "server_shortname",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Houston"
}
},
{
"name": "server_hostname",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "houston.voip.ms"
}
},
{
"name": "server_ip",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "209.62.1.2"
}
},
{
"name": "server_country",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "USA"
}
},
{
"name": "server_pop",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "server_recommended",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "Yes"
}
}
]
}
}
}
]
},
"getTransactionHistory": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "transactions",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2016-06-03 00:03:46"
}
},
{
"name": "uniqueid",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "12964421x41098i8c"
}
},
{
"name": "type",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "DID8555555555"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "DID Monthly Fee: 8555555555"
}
},
{
"name": "ammount",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "-0.99"
}
}
]
}
}
}
]
},
"createSubAccount": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "99785"
}
},
{
"name": "account",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "100000_VoIP"
}
}
]
},
"delSubAccount": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"getAllowedCodecs": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "allowed_codecs",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ulaw"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "G.711U"
}
}
]
}
}
}
]
},
"getAuthTypes": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "auth_types",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Static IP Authentication"
}
}
]
}
}
}
]
},
"getDeviceTypes": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "device_types",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Asterisk, IP PBX, Gateway or VoIP Switch"
}
}
]
}
}
}
]
},
"getDTMFModes": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "dtmf_modes",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "inband"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "INBAND"
}
}
]
}
}
}
]
},
"getLockInternational": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "lock_international",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "International Calls Disabled"
}
}
]
}
}
}
]
},
"getMusicOnHold": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "music_on_hold",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "jazz"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Easy Listening"
}
},
{
"name": "recordings",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "100010,100011"
}
},
{
"name": "total",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "volume",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "mp3"
}
},
{
"name": "sort",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "random"
}
},
{
"name": "custom",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
}
]
}
}
}
]
},
"setMusicOnHold": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delMusicOnHold": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"getNAT": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "nat",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "route"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Route"
}
}
]
}
}
}
]
},
"getProtocols": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "protocols",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "3"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "IAX2"
}
}
]
}
}
}
]
},
"getRegistrationStatus": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "registered",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "rerouted",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "from_server_pop",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "65"
}
},
{
"name": "registrations",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "server_name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Atlanta, GA"
}
},
{
"name": "server_shortname",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Atlanta"
}
},
{
"name": "server_hostname",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "atlanta.voip.ms"
}
},
{
"name": "server_ip",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "174.34.146.162"
}
},
{
"name": "server_country",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "USA"
}
},
{
"name": "server_pop",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "15"
}
},
{
"name": "register_ip",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "189.148.32.179"
}
},
{
"name": "register_port",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "59870"
}
},
{
"name": "register_next",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2010-11-30 16:48:30"
}
},
{
"name": "register_protocol",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "SIP"
}
},
{
"name": "register_transport",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "UDP"
}
}
]
}
}
}
]
},
"getReportEstimatedHoldTime": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "types",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "Yes"
}
}
]
}
}
}
]
},
"getRoutes": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "routes",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Premium"
}
}
]
}
}
}
]
},
"getSubAccounts": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "accounts",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "99785"
}
},
{
"name": "account",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "100000_VoIP"
}
},
{
"name": "username",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "VoIP"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "My VoIP Account"
}
},
{
"name": "protocol",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "auth_type",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "password",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "voip@house"
}
},
{
"name": "ip",
"shape": {
"kind": "scalar",
"type": "string",
"sample": ""
}
},
{
"name": "device_type",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "callerid_number",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551234567"
}
},
{
"name": "canada_routing",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "lock_international",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "international_route",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "music_on_hold",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "jazz"
}
},
{
"name": "language",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "en"
}
},
{
"name": "allowed_codecs",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ulaw;gsm"
}
},
{
"name": "dtmf_mode",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "auto"
}
},
{
"name": "nat",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "sip_traffic",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "max_expiry",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "3600"
}
},
{
"name": "rtp_timeout",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "60"
}
},
{
"name": "rtp_hold_timeout",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "600"
}
},
{
"name": "ip_restriction",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "187.26.33.87/25,104.255.12.0/22"
}
},
{
"name": "enable_ip_restriction",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "pop_restriction",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "82,83,84,71,73,74,97"
}
},
{
"name": "enable_pop_restriction",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "send_bye",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "record_calls",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "internal_extension",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "internal_voicemail",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "100"
}
},
{
"name": "internal_dialtime",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "30"
}
},
{
"name": "reseller_client",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "561115"
}
},
{
"name": "reseller_package",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "92364"
}
},
{
"name": "reseller_nextbilling",
"shape": {
"kind": "scalar",
"type": "date",
"sample": "2012-12-31"
}
},
{
"name": "transcribe",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "transcription_locale",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "en-US"
}
},
{
"name": "transcription_redaction",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "transcription_summary",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "transcription_sentiment",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "transcription_email",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "<a href=\"/cdn-cgi/l/email-protection\" class=\"__cf_email__\" data-cfemail=\"532736202713362b323e233f367d303c3e\">[email protected]</a>"
}
},
{
"name": "parking_lot",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "323"
}
},
{
"name": "enable_internal_cnam",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "internal_cnam",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "office"
}
},
{
"name": "tfcarrier",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "default_e911",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5574223344"
}
},
{
"name": "call_pickup_behavior",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "1 (Can Pick Up and Be Picked Up) 2 (Can Pick Up (Can 't be Picked Up)) 3 (Can Be Picked Up (Can't Pick Up)) 4 (Disabled (Can't Pick Up nor Get Picked Up)) internal_extension_location] => 0"
}
}
]
}
}
}
]
},
"getCallTranscriptions": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "transcriptions",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"2024-10-11 08:48:40\""
}
},
{
"name": "duration",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"00:07\""
}
},
{
"name": "speakers",
"shape": {
"kind": "list",
"element": {
"kind": "scalar",
"type": "string",
"sample": "\"3314315459\""
}
}
},
{
"name": "locale",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"en-US\""
}
},
{
"name": "confidence",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"94.18%\""
}
},
{
"name": "recognized_phrases",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "time",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"2024-10-11 08:48:21\""
}
},
{
"name": "duration",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "2.84"
}
},
{
"name": "speaker",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "phrase",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"That number has not yet been assigned.\""
}
}
]
}
}
}
]
}
}
}
]
},
"getVoicemailTranscriptions": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "messages",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"2024-10-11 12:52:46\""
}
},
{
"name": "callerid",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"3314315459 <3314315459>\","
}
},
{
"name": "duration",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"00:00:09\","
}
},
{
"name": "folder",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"INBOX\","
}
},
{
"name": "result",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"translation example\""
}
}
]
}
}
}
]
},
"setSubAccount": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"getLocations": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "locations",
"shape": {
"kind": "list",
"element": {
"kind": "scalar",
"type": "string",
"sample": "Reachable by everyone"
}
}
}
]
},
"setLocation": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delLocation": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"getCallParking": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "call_hunting",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "callparking",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "13"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "new callparking"
}
},
{
"name": "timeout",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "60"
}
},
{
"name": "musiconhold",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "away_in_the_tropics"
}
},
{
"name": "failover",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "callback"
}
},
{
"name": "language",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "en"
}
},
{
"name": "destination",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "parker"
}
},
{
"name": "delay",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5"
}
},
{
"name": "blf_lamps",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "10"
}
}
]
}
}
}
]
},
"setCallParking": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "callparking",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "235"
}
}
]
},
"delCallParking": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"getCallRecordings": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "recordings",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "callrecording",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "MTA5Nzk5LTUyOTk5MjQyNjE5NC01Mjk5OTM5OTA1MjAtSU4tMTU0NDEzMTMwNg"
}
},
{
"name": "datetime",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2018-12-06 16:21:46"
}
},
{
"name": "destination",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "999999999"
}
},
{
"name": "type",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Incoming"
}
},
{
"name": "subaccount",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "109799"
}
},
{
"name": "duration",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "00:26"
}
}
]
}
}
}
]
},
"getCallRecording": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "callrecording",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "MTA5Nzk5LTUyOTk5MjQyNjE5NC01Mjk5OTM5OTA1MjAtSU4tMTU0NDEzMTMwNg"
}
},
{
"name": "datetime",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2018-12-06 16:21:46"
}
},
{
"name": "destination",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "999999999"
}
},
{
"name": "type",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Incoming"
}
},
{
"name": "subaccount",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "109799"
}
},
{
"name": "duration",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "00:26"
}
},
{
"name": "base64file",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"\\/+M4xAAAAAAAAAAAAEluZm8AAAAPAAABZwA BL8AAAgUHCgwPEhQXGRwfISQmKSwuMTM2ODs + QENFSEpNT1JUV1lcXmFkZmlrbnBzdnh7fYCDhYiKjZCSlZeanJ+hpKapq66ws7W4u73AwsXIys3P0tTX2tzf4eTn6 e zu8fP2+Pv9AAAAOUxBTUUzLjEwMAEoAAAAAC47AAAUGCQDoCIAABgAAS\\/As5k+3wAAAAAAAAAAAAAAAAAAAAAAA AA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\/+M4xAAmNCH9VUlAAYAPYgDLnPqQy0CBAgQIIWRggGGLRo0c985z nOe +c0aNG3tIBWK26UQIIWKGJ\\/\\/8IKCgpQuAoCwPKd3d0qXPf\\/3d7hDBcXe4REr9Pe0F3hDE3vRETd34Tl3uHd74T9 ERK 5cxNy3fQXFz30RJFE3vRNK+ERJISv\\/0REr5dErd3uHd3v9He9ET0Svm9Hd+ESpQUFABweAZh4+GPQSSEKSQZG8sO GQeK +YLINRg7ATMPMUczw0yQBDMaGoAINm\\/\\/4AvRi8NBkGAKACwWCP\\/\\/+M4xDI6I8Jw8Z54AP85XD9+NrUcB9v\\/\\ /0PU cc5zTVcr5HGg2HN\\/\\/\\/\\/nfV8f\\/KwRh2pgxk4GGLn\\/\\/\\/\\/\\/Heavp\\/HQiDHPwhAsLt+UhOxukBMv\\/\\/\\/ \\/\\/ +ZjVZoE4VD4tiEEvZ7vTZQtNj\\/L6JkG\\/CNKd5\\/\\/\\/\\/\\/\\/\\/k\\/0eaZByxnQaCEEvjMijT7Ge5AkJJ7KSJF I9pZk uvob\\/\\/\\/\\/\\/\\/\\/\\/+cYRhUaIWaarajkWDoiv0LeaXjQPE04imlV6YqUZuvC\\/pI7DLXl1pQAogHb5GmoAytT LKUh\""
}
}
]
},
"sendCallRecordingEmail": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "msg",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Email sent to <a href=\"/cdn-cgi/l/email-protection\" class=\"__cf_email__\" data-cfemail=\"1d707c74715d6e72736d7c7364337e7270\">[email protected]</a>"
}
}
]
},
"delCallRecording": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"getCallAccounts": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "accounts",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "all"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "All Accounts"
}
}
]
}
}
}
]
},
"getCallBilling": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "call_billing",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "all"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "All Calls"
}
}
]
}
}
}
]
},
"getCallTypes": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "call_types",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "all"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "All Calls"
}
}
]
}
}
}
]
},
"getCDR": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "cdr",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2010-11-30 10:40:16"
}
},
{
"name": "callerid",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"John Doe\" <5551112222>"
}
},
{
"name": "destination",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551234567"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Inbound - Local Caller"
}
},
{
"name": "account",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "100000_VoIP"
}
},
{
"name": "disposition",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ANSWERED"
}
},
{
"name": "duration",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "00:00:11"
}
},
{
"name": "seconds",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "11"
}
},
{
"name": "rate",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00000000"
}
},
{
"name": "total",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00000000"
}
},
{
"name": "uniqueid",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "128238059"
}
},
{
"name": "destination_type",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "IN:USA"
}
},
{
"name": "call_logs",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Call logs for UniqueID: 999999 Routing to sub-account: 100000_VoIP Status is 'Channel not available' Failover due to 'Unreachable' status Routing to Ring group: test_ringgroup Hangup: Channel is unavailable"
}
}
]
}
}
}
]
},
"getRates": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "rates",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "destination",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Canada - 418 Quebec City"
}
},
{
"name": "prefix",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1418"
}
},
{
"name": "client_increment",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "60"
}
},
{
"name": "client_rate",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.015"
}
},
{
"name": "real_increment",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "6"
}
},
{
"name": "real_rate",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.0052"
}
}
]
}
}
}
]
},
"getTerminationRates": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "route",
"shape": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Premium"
}
}
]
}
},
{
"name": "rates",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "destination",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Canada - 204 Manitoba"
}
},
{
"name": "prefix",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1204"
}
},
{
"name": "increment",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "6"
}
},
{
"name": "rate",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.009"
}
}
]
}
}
}
]
},
"getResellerCDR": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "cdr",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2010-11-30 10:40:16"
}
},
{
"name": "callerid",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"John Doe\" <5551112222>"
}
},
{
"name": "destination",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551234567"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Inbound - Local Caller"
}
},
{
"name": "account",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "100000_VoIP"
}
},
{
"name": "disposition",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ANSWERED"
}
},
{
"name": "duration",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "00:00:11"
}
},
{
"name": "seconds",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "11"
}
},
{
"name": "total",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.015"
}
},
{
"name": "uniqueid",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "128238059"
}
},
{
"name": "destination_type",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "IN:USA"
}
},
{
"name": "call_logs",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Call logs for UniqueID: 999999 Routing to sub-account: 100000_VoIP Status is 'Channel not available' Failover due to 'Unreachable' status Routing to Ring group: test_ringgroup Hangup: Channel is unavailable"
}
}
]
}
}
}
]
},
"getResellerSMS": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "sms",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "111120"
}
},
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2014-03-30 10:24:16"
}
},
{
"name": "type",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8574884828"
}
},
{
"name": "contact",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8577884821"
}
},
{
"name": "message",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "hello+john"
}
}
]
}
}
}
]
},
"getResellerMMS": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "sms",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "111120"
}
},
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2014-03-30 10:24:16"
}
},
{
"name": "type",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8574884828"
}
},
{
"name": "contact",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8577884821"
}
},
{
"name": "message",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "hello+john"
}
}
]
}
}
}
]
},
"addCharge": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"addPayment": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"assignDIDvPRI": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "vpri",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5"
}
},
{
"name": "DIDAdded",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551234567"
}
},
{
"name": "monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "2.00"
}
}
]
},
"getBalanceManagement": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "balance_management",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Hard - suspend the client"
}
}
]
}
}
}
]
},
"getCharges": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "charges",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "475568"
}
},
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "date",
"sample": "2010-10-29"
}
},
{
"name": "amount",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "2.00"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "DID5551234567"
}
}
]
}
}
}
]
},
"getClientPackages": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "packages",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8378"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "VoIP"
}
}
]
}
}
}
]
},
"getClients": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "clients",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "client",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "561115"
}
},
{
"name": "email",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "<a href=\"/cdn-cgi/l/email-protection\" class=\"__cf_email__\" data-cfemail=\"89e3e6e1e7a7ede6ecc9e4f0a4ede6e4e8e0e7a7eae6e4\">[email protected]</a>"
}
},
{
"name": "password",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "johnspassword"
}
},
{
"name": "company",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Consulting"
}
},
{
"name": "firstname",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "John"
}
},
{
"name": "lastname",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Doe"
}
},
{
"name": "address",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "5491 190TH"
}
},
{
"name": "city",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "OPA LOCKA"
}
},
{
"name": "state",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "FLORIDA"
}
},
{
"name": "country",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "UNITED STATES"
}
},
{
"name": "zip",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "33055"
}
},
{
"name": "phone_number",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551112222"
}
},
{
"name": "balance_management",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
}
]
}
}
}
]
},
"getClientThreshold": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "threshold_information",
"shape": {
"kind": "object",
"fields": [
{
"name": "threshold",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "130"
}
},
{
"name": "email",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "<a href=\"/cdn-cgi/l/email-protection\" class=\"__cf_email__\" data-cfemail=\"22484d4a4c0c464d47624f5b0f464d4f434b4c0c414d4f\">[email protected]</a>"
}
}
]
}
}
]
},
"getDeposits": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "deposits",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "808639"
}
},
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "date",
"sample": "2010-10-15"
}
},
{
"name": "amount",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "4.00"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Credit : 2 Setup Charges"
}
}
]
}
}
}
]
},
"getPackages": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "packages",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "package",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8378"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "VoIP"
}
},
{
"name": "markup_fixed",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.01"
}
},
{
"name": "markup_percentage",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "50"
}
},
{
"name": "pulse",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "60"
}
},
{
"name": "international_route",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "canada_route",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "monthly_fee",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "2.00"
}
},
{
"name": "setup_fee",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "1.00"
}
},
{
"name": "free_minutes",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
}
]
}
}
}
]
},
"getResellerBalance": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "balance",
"shape": {
"kind": "object",
"fields": [
{
"name": "current_balance",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "8.0588"
}
},
{
"name": "spent_total",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "1.9012"
}
},
{
"name": "calls_total",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "56"
}
},
{
"name": "time_total",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "51:35"
}
},
{
"name": "spent_today",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.045"
}
},
{
"name": "calls_today",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "time_today",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "2:50"
}
}
]
}
}
]
},
"setClient": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"setClientThreshold": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"setConference": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "conference",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1234"
}
}
]
},
"setConferenceMember": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "member",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1234"
}
}
]
},
"signupClient": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "client",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1234"
}
}
]
},
"backOrderDIDUSA": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"backOrderDIDCAN": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"cancelDID": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"connectDID": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delCallback": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delCallerIDFiltering": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delCallHunting": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delClient": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delConference": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delConferenceMember": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delDISA": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"deleteSMS": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"deleteMMS": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delForwarding": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delIVR": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delPhonebook": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delPhonebookGroup": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delQueue": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delRecording": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delRingGroup": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delSIPURI": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delStaticMember": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delTimeCondition": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"getCallbacks": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "callbacks",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "callback",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2359"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "John Smith"
}
},
{
"name": "number",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551234567"
}
},
{
"name": "delay_before",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5"
}
},
{
"name": "response_timeout",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "10"
}
},
{
"name": "digit_timeout",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5"
}
},
{
"name": "callerid_number",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5552223333"
}
}
]
}
}
}
]
},
"getCallerIDFiltering": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "filtering",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "filtering",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "18915"
}
},
{
"name": "callerid",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551234567"
}
},
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5552223333"
}
},
{
"name": "routing",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "cb:2359"
}
},
{
"name": "failover_unreachable",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none:"
}
},
{
"name": "failover_busy",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none:"
}
},
{
"name": "failover_noanswer",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none:"
}
},
{
"name": "note",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Callback Filtering"
}
}
]
}
}
}
]
},
"getCallHuntings": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "call_hunting",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "callhunting",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "13"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "test"
}
},
{
"name": "members",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "account:11111;none:;none:;none:;none:;none:;none:;none:"
}
},
{
"name": "ring_time",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "20;20;20;20;20;20;20;20"
}
},
{
"name": "order",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "follow"
}
},
{
"name": "press",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "1;1;1;1;1;1;1;1"
}
},
{
"name": "music",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "default"
}
},
{
"name": "recording",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "default"
}
},
{
"name": "language",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "en"
}
}
]
}
}
}
]
},
"getDIDCountries": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "countries",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "205"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "SWEDEN (+46)"
}
}
]
}
}
}
]
},
"getCarriers": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "carriers",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "American Carrier, American and Canadian Callers allowed"
}
}
]
}
}
}
]
},
"getDIDsCAN": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "dids",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2264836080"
}
},
{
"name": "ratecenter",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Stoney Point"
}
},
{
"name": "province",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ON"
}
},
{
"name": "province_description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ONTARIO"
}
},
{
"name": "perminute_monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.99"
}
},
{
"name": "perminute_minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.0100"
}
},
{
"name": "perminute_setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.50"
}
},
{
"name": "flat_monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "4.95"
}
},
{
"name": "flat_minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00"
}
},
{
"name": "flat_setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "1.00"
}
},
{
"name": "sms",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
}
]
}
}
}
]
},
"getDIDsInfo": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "dids",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551234567"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "MIAMI, FL"
}
},
{
"name": "routing",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "account:100001_VoIP"
}
},
{
"name": "failover_busy",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none:"
}
},
{
"name": "failover_unreachable",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "fwd:1521"
}
},
{
"name": "failover_noanswer",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none:"
}
},
{
"name": "voicemail",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1001"
}
},
{
"name": "pop",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "16"
}
},
{
"name": "dialtime",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "60"
}
},
{
"name": "cnam",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "e911",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "callerid_prefix",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "MIA [555]"
}
},
{
"name": "note",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "MIA [555]"
}
},
{
"name": "port_out_pin",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1234"
}
},
{
"name": "billing_type",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "next_billing",
"shape": {
"kind": "scalar",
"type": "date",
"sample": "2014-08-30"
}
},
{
"name": "order_date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2014-07-30 15:09:04"
}
},
{
"name": "reseller_account",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "100001_VoIPReseller"
}
},
{
"name": "reseller_next_billing",
"shape": {
"kind": "scalar",
"type": "date",
"sample": "2014-08-30"
}
},
{
"name": "reseller_monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00000000"
}
},
{
"name": "reseller_minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.01000000"
}
},
{
"name": "reseller_setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00000000"
}
},
{
"name": "sms_available",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "sms_enabled",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "sms_email",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "<a href=\"/cdn-cgi/l/email-protection\" class=\"__cf_email__\" data-cfemail=\"2943464147074d464c694c51484459454c074a4644\">[email protected]</a>"
}
},
{
"name": "sms_email_enabled",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "sms_forward",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2264836086"
}
},
{
"name": "sms_forward_enabled",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "sms_url_callback",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "http://myurl.com"
}
},
{
"name": "sms_url_callback_enabled",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "sms_url_callback_retry",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "smpp_enabled",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "smpp_url",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "http://myurl.com"
}
},
{
"name": "smpp_user",
"shape": {
"kind": "scalar",
"type": "string",
"sample": ""
}
},
{
"name": "smpp_pass",
"shape": {
"kind": "scalar",
"type": "string",
"sample": ""
}
},
{
"name": "transcribe",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "transcription_locale",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "en-US"
}
},
{
"name": "transcription_redaction",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "transcription_summary",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "transcription_sentiment",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "transcription_email",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "<a href=\"/cdn-cgi/l/email-protection\" class=\"__cf_email__\" data-cfemail=\"f480918780b4918c9599849891da979b99\">[email protected]</a>"
}
}
]
}
}
}
]
},
"getDIDsInternationalGeographic": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "locations",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "location_id",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "a65"
}
},
{
"name": "location_name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "HELSINKI"
}
},
{
"name": "country",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "FINLAND"
}
},
{
"name": "area_code",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "9"
}
},
{
"name": "stock",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "5.00"
}
},
{
"name": "setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00"
}
},
{
"name": "minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00"
}
},
{
"name": "monthly_per_minute",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "7.00,"
}
},
{
"name": "setup_per_minute",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "5.50,"
}
},
{
"name": "channels",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
}
]
}
}
}
]
},
"getDIDsInternationalNational": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "locations",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "location_id",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "a5644"
}
},
{
"name": "location_name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "NATIONAL"
}
},
{
"name": "country",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "SPAIN"
}
},
{
"name": "area_code",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "901"
}
},
{
"name": "stock",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "4"
}
},
{
"name": "monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "11.50"
}
},
{
"name": "setup",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "11"
}
},
{
"name": "minute",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "monthly_per_minute",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "6.00,"
}
},
{
"name": "setup_per_minute",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "5.50,"
}
}
]
}
}
}
]
},
"getDIDsInternationalTollFree": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "locations",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "location_id",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "a6422"
}
},
{
"name": "location_name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "TOLLFREE"
}
},
{
"name": "country",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ARGENTINA"
}
},
{
"name": "area_code",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "800"
}
},
{
"name": "stock",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "19"
}
},
{
"name": "monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "37.50"
}
},
{
"name": "setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "72.50"
}
},
{
"name": "minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.20"
}
}
]
}
}
}
]
},
"getDIDsUSA": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "dids",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "7862285619"
}
},
{
"name": "ratecenter",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "MIAMI"
}
},
{
"name": "state",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "FL"
}
},
{
"name": "state_description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "FLORIDA"
}
},
{
"name": "perminute_monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.99"
}
},
{
"name": "perminute_minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.01"
}
},
{
"name": "perminute_setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.50"
}
},
{
"name": "flat_monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "4.95"
}
},
{
"name": "flat_minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00"
}
},
{
"name": "flat_setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "1.00"
}
},
{
"name": "has_port_out_pin",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "sms",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
}
]
}
}
}
]
},
"getDIDvPRI": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "vpri"
}
},
{
"name": "dids",
"shape": {
"kind": "list",
"element": {
"kind": "scalar",
"type": "integer",
"sample": "7862285619"
}
}
}
]
},
"getDISAs": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "disa",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "disa",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2114"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Jonhs DISA"
}
},
{
"name": "pin",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1234"
}
},
{
"name": "digit_timeout",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "10"
}
},
{
"name": "callerid_override",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5552223333"
}
},
{
"name": "language",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "fr"
}
}
]
}
}
}
]
},
"getForwardings": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "forwardings",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "forwarding",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "18635"
}
},
{
"name": "phone_number",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5553334444"
}
},
{
"name": "callerid_override",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551234567"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "RESELLER| 5553334444"
}
},
{
"name": "dtmf_digits",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "123"
}
},
{
"name": "pause",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "1.5"
}
},
{
"name": "diversion_header",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
}
]
}
}
}
]
},
"getInternationalTypes": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "types",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "NATIONAL"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "National Numbers (Non-Geographical)"
}
}
]
}
}
}
]
},
"getIVRs": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "ivrs",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "ivr",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "4636"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Johns IVR"
}
},
{
"name": "recording",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "7696"
}
},
{
"name": "timeout",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5"
}
},
{
"name": "language",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "fr"
}
},
{
"name": "voicemailsetup",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "choices",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "1=sip:5096;2=fwd:20222"
}
}
]
}
}
}
]
},
"getJoinWhenEmptyTypes": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "types",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "Yes"
}
}
]
}
}
}
]
},
"getPhonebook": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "phonebooks",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "phonebook",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "32207"
}
},
{
"name": "speed_dial",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "*7501"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Jane Smith"
}
},
{
"name": "number",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5553334444"
}
},
{
"name": "callerid",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5552223333"
}
},
{
"name": "note",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Janes Mobile"
}
},
{
"name": "group",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "3220"
}
},
{
"name": "group_name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Work"
}
}
]
}
}
}
]
},
"getPhonebookGroups": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "phonebooks",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "phonebook_group",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "32207"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Work"
}
},
{
"name": "members",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "123456;654321"
}
}
]
}
}
}
]
},
"getPortability": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "portable",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "sms",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "plans",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "title",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Per Minute Plan"
}
},
{
"name": "pricePerMonth",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.99"
}
},
{
"name": "pricePerMin",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.01"
}
}
]
}
}
}
]
},
"getRecordings": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "recordings",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "7567"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "IVR Recording"
}
}
]
}
}
}
]
},
"getRecordingFile": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "recordings",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "7567"
}
},
{
"name": "data",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "UklGRqTEAQBXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YYDEA...."
}
}
]
}
}
}
]
},
"getRingGroups": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "ring_groups",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "ring_group",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "4768"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Account & Mobile"
}
},
{
"name": "caller_announcement",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "7567"
}
},
{
"name": "music_on_hold",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "jazz"
}
},
{
"name": "language",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "en"
}
},
{
"name": "members",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "account:100001;fwd:16006"
}
},
{
"name": "voicemail",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "101"
}
}
]
}
}
}
]
},
"getRingStrategies": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "strategies",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "rrmemory"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Round Robin Memory"
}
}
]
}
}
}
]
},
"getSIPURIs": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "sipuris",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "sipuri",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "6199"
}
},
{
"name": "uri",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "<a href=\"/cdn-cgi/l/email-protection\" class=\"__cf_email__\" data-cfemail=\"063333333434343535353546756f762870696f76286b75\">[email protected]</a>"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Jonh Smith"
}
},
{
"name": "callerid_override",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "529999999"
}
},
{
"name": "callerid_e164",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
}
]
}
}
}
]
},
"getSMS": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "sms",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "111120"
}
},
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2014-03-30 10:24:16"
}
},
{
"name": "type",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8574884828"
}
},
{
"name": "contact",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8577884821"
}
},
{
"name": "message",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "hello+john"
}
},
{
"name": "carrier_status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Information not available"
}
}
]
}
}
}
]
},
"getMMS": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "sms",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "111120"
}
},
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2014-03-30 10:24:16"
}
},
{
"name": "type",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8574884828"
}
},
{
"name": "contact",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8577884821"
}
},
{
"name": "message",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "hello+john"
}
},
{
"name": "carrier_status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Status of a message (Example: 'Information not available')"
}
},
{
"name": "col_media1",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"https://voip.ms/media.php?map=MTU5MzUzMDcTk2NNUw==\""
}
},
{
"name": "col_media2",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"\""
}
},
{
"name": "col_media3",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"\""
}
},
{
"name": "media",
"shape": {
"kind": "list",
"element": {
"kind": "scalar",
"type": "string",
"sample": "'https://voip.ms/media.php?map=MTU5MzUzMDcTk2NNUw=='"
}
}
}
]
}
}
}
]
},
"getMediaMMS": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "272377221"
}
},
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2014-03-30 10:24:16"
}
},
{
"name": "media",
"shape": {
"kind": "scalar",
"type": "string",
"sample": " ("
}
},
{
"name": "0",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "'https://voip.ms/media.php?map=MTU5MzUzMDcTk2NNUw=='"
}
},
{
"name": "1",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "''"
}
},
{
"name": "2",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "''"
}
}
]
},
"getProvinces": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "provinces",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "province",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ON"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ONTARIO"
}
}
]
}
}
}
]
},
"getQueues": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "queues",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "queue",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "3008"
}
},
{
"name": "queue_name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "call_center5"
}
},
{
"name": "queue_number",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "6"
}
},
{
"name": "queue_language",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "en"
}
},
{
"name": "queue_password",
"shape": {
"kind": "scalar",
"type": "string",
"sample": ""
}
},
{
"name": "callerid_prefix",
"shape": {
"kind": "scalar",
"type": "string",
"sample": ""
}
},
{
"name": "join_announcement",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none"
}
},
{
"name": "priority_weight",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "agent_announcement",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "report_hold_time_agent",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "member_delay",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "10"
}
},
{
"name": "music_on_hold",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "jazz"
}
},
{
"name": "maximum_wait_time",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "60"
}
},
{
"name": "maximum_callers",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "10"
}
},
{
"name": "join_when_empty",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "leave_when_empty",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "ring_strategy",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "rrmemory"
}
},
{
"name": "ring_inuse",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "agent_ring_timeout",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5"
}
},
{
"name": "retry_timer",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5"
}
},
{
"name": "wrapup_time",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "20"
}
},
{
"name": "voice_announcement",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "frequency_announcement",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none"
}
},
{
"name": "announce_position_frecuency",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none"
}
},
{
"name": "announce_round_seconds",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none"
}
},
{
"name": "if_announce_position_enabled_report_estimated_hold_time",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "thankyou_for_your_patience",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "fail_over_routing_timeout",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "fwd:19999"
}
},
{
"name": "fail_over_routing_full",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "vm:149601"
}
},
{
"name": "fail_over_routing_join_empty",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "fwd:15555"
}
},
{
"name": "fail_over_routing_leave_empty",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none:"
}
},
{
"name": "fail_over_routing_join_unavail",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none:"
}
},
{
"name": "fail_over_routing_leave_unavail",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none:"
}
}
]
}
}
}
]
},
"getRateCentersCAN": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "ratecenters",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "ratecenter",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Calgary"
}
},
{
"name": "available",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
}
]
}
}
}
]
},
"getRateCentersUSA": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "ratecenters",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "ratecenter",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ALFORD"
}
},
{
"name": "available",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
}
]
}
}
}
]
},
"getStates": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "states",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "state",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "AL"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ALABAMA"
}
}
]
}
}
}
]
},
"getStaticMembers": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "members",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "member",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "163"
}
},
{
"name": "queue_number",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "4136"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "as"
}
},
{
"name": "account",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "SIP/10000_johnsmith"
}
},
{
"name": "priority",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
}
]
}
}
}
]
},
"getTimeConditions": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "timecondition",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "timecondition",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1830"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Johns Work"
}
},
{
"name": "routing_match",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "account:100001"
}
},
{
"name": "routing_nomatch",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "vm:101"
}
},
{
"name": "starthour",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "8;8"
}
},
{
"name": "startminute",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "0;0"
}
},
{
"name": "endhour",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "16;12"
}
},
{
"name": "endminute",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "0;0"
}
},
{
"name": "weekdaystart",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "mon;sat"
}
},
{
"name": "weekdayend",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "fri;sat"
}
}
]
}
}
}
]
},
"getVoicemailSetups": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "voicemailsetups",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Account Voicemail"
}
}
]
}
}
}
]
},
"getVoicemailAttachmentFormats": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "email_attachment_formats",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "wav49"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Recommended Smaller File Size"
}
}
]
}
}
}
]
},
"orderDID": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"orderDIDInternationalGeographic": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"orderDIDInternationalNational": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"orderDIDInternationalTollFree": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"orderDIDVirtual": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"orderTollFree": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"orderVanity": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"removeDIDvPRI": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "vpri",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "358"
}
},
{
"name": "DIDRemoved",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "561115"
}
}
]
},
"searchDIDsCAN": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "dids",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "4502381568"
}
},
{
"name": "ratecenter",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Chomedey"
}
},
{
"name": "province",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "QC"
}
},
{
"name": "province_description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "QUEBEC"
}
},
{
"name": "perminute_monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.99"
}
},
{
"name": "perminute_minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.0100"
}
},
{
"name": "perminute_setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.50"
}
},
{
"name": "flat_monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "4.95"
}
},
{
"name": "flat_minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00"
}
},
{
"name": "flat_setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "1.00"
}
}
]
}
}
}
]
},
"searchDIDsUSA": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "dids",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "7863643023"
}
},
{
"name": "ratecenter",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "MIAMI"
}
},
{
"name": "state",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "FL"
}
},
{
"name": "state_description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "FLORIDA"
}
},
{
"name": "perminute_monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.99"
}
},
{
"name": "perminute_minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.01"
}
},
{
"name": "perminute_setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.50"
}
},
{
"name": "flat_monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "4.95"
}
},
{
"name": "flat_minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00"
}
},
{
"name": "flat_setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "1.00"
}
}
]
}
}
}
]
},
"searchTollFreeCanUS": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "dids",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8774530644"
}
},
{
"name": "monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "1.49"
}
},
{
"name": "minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.0320"
}
},
{
"name": "setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00"
}
}
]
}
}
}
]
},
"searchTollFreeUSA": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "dids",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8888355579"
}
},
{
"name": "monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.99"
}
},
{
"name": "minute_usa",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.019"
}
},
{
"name": "minute_canada",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.08"
}
},
{
"name": "minute_puertorico",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.095"
}
},
{
"name": "minute_alaska",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.17"
}
},
{
"name": "setup",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
}
]
}
}
}
]
},
"searchVanity": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "dids",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "8776605646"
}
},
{
"name": "monthly_american",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.99"
}
},
{
"name": "monthly_canadian",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "1.49"
}
},
{
"name": "minute_american_usa",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.019"
}
},
{
"name": "minute_american_canada",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.08"
}
},
{
"name": "minute_canadian",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.032"
}
},
{
"name": "setup_american",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "15"
}
},
{
"name": "setup_canadian",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "30"
}
}
]
}
}
}
]
},
"sendSMS": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "sms",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "23434"
}
}
]
},
"sendMMS": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "mms",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "23434"
}
}
]
},
"setCallback": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "callback",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2359"
}
}
]
},
"setCallerIDFiltering": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "filtering",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "18915"
}
}
]
},
"setCallHunting": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "call_hunting",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "235"
}
}
]
},
"setDIDBillingType": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"setDIDInfo": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"setDIDPOP": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"setDIDRouting": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"setDIDVoicemail": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"setDISA": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "disa",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2114"
}
}
]
},
"setForwarding": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "forwarding",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "19183"
}
}
]
},
"setIVR": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "ivr",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "4636"
}
}
]
},
"setPhonebook": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "phonebook",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "32207"
}
}
]
},
"setPhonebookGroup": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "group",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "32207"
}
}
]
},
"setRecording": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "recording",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "33221"
}
}
]
},
"setQueue": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "queue",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "32208"
}
}
]
},
"setRingGroup": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "ring_group",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "4768"
}
}
]
},
"setSMS": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "sipuri",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "6199"
}
}
]
},
"setStaticMember": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "member",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "619"
}
}
]
},
"setTimeCondition": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "timecondition",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1830"
}
}
]
},
"unconnectDID": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"connectFAX": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"unconnectFAX": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"cancelFaxNumber": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "deleted_did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551234567"
}
}
]
},
"deleteFaxMessage": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delEmailToFax": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delFaxFolder": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"getBackOrders": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "quantity",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "back_orders",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1234"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "MIAMI, FL"
}
},
{
"name": "routing",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "account:100001_VoIP"
}
},
{
"name": "failover_busy",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none:"
}
},
{
"name": "failover_unreachable",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "fwd:1521"
}
},
{
"name": "failover_noanswer",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "none:"
}
},
{
"name": "voicemail",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1001"
}
},
{
"name": "pop",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "16"
}
},
{
"name": "dialtime",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "60"
}
},
{
"name": "cnam",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "billing_type",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "order_date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2014-07-30 15:09:04"
}
}
]
}
}
}
]
},
"getFaxProvinces": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "provinces",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "province",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "AB"
}
},
{
"name": "province_id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "60"
}
},
{
"name": "province_name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Alberta"
}
},
{
"name": "country_code",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "CAN"
}
}
]
}
}
}
]
},
"getFaxStates": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "states",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "state",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "AL"
}
},
{
"name": "state_id",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "state_name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Alabama"
}
},
{
"name": "country_code",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "USA"
}
}
]
}
}
}
]
},
"getFaxRateCentersCAN": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "ratecenters",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "location",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "20294"
}
},
{
"name": "area_code",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "587"
}
},
{
"name": "ratecenter",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "EDMONTON"
}
},
{
"name": "available",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
}
]
}
}
}
]
},
"getFaxRateCentersUSA": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "ratecenters",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "location",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1196"
}
},
{
"name": "area_code",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "205"
}
},
{
"name": "ratecenter",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ALABASTER"
}
},
{
"name": "available",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
}
]
}
}
}
]
},
"getFaxNumbersInfo": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "numbers",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "0000"
}
},
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551234567"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "United States, CA, HALF MOON BAY"
}
},
{
"name": "state",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "CA"
}
},
{
"name": "city",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "HALF MOON BAY"
}
},
{
"name": "country",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "United States"
}
},
{
"name": "email_enabled",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "email",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "<a href=\"/cdn-cgi/l/email-protection\" class=\"__cf_email__\" data-cfemail=\"6d0c09091f081e1e2d08000c0401430e0200\">[email protected]</a>"
}
},
{
"name": "url_enabled",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "url",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "www.example.com"
}
},
{
"name": "retry",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
},
{
"name": "attach_file",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "note",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"testing\""
}
},
{
"name": "reseller_account",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "100001_VoIPReseller"
}
},
{
"name": "reseller_next_billing",
"shape": {
"kind": "scalar",
"type": "date",
"sample": "2014-08-30"
}
},
{
"name": "reseller_monthly",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00000000"
}
},
{
"name": "reseller_minute",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.01000000"
}
},
{
"name": "reseller_setup",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.00000000"
}
},
{
"name": "fax_to_sip_enabled",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "fax_to_sip_enabled_account",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "100001_VoIPReseller2"
}
}
]
}
}
}
]
},
"getFaxNumbersPortability": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "getFaxNumbersPortability",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
}
]
},
"getFaxMessages": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "faxes",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "0000"
}
},
{
"name": "folder",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "INBOX"
}
},
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "datetime",
"sample": "2016-01-01 00:00:00"
}
},
{
"name": "callerid",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5552341234"
}
},
{
"name": "stationid",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5552341234"
}
},
{
"name": "destination",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "7772341234"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "INBOUND FAX"
}
},
{
"name": "pages",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "duration",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "1:16"
}
},
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "SUCCESS"
}
},
{
"name": "rate",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.000"
}
},
{
"name": "total",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.000"
}
},
{
"name": "msg",
"shape": {
"kind": "scalar",
"type": "string",
"sample": ""
}
}
]
}
}
}
]
},
"getFaxMessagePDF": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "message_base64",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "PDF file encrypted in Base64"
}
}
]
},
"getFaxFolders": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "folders",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "0000"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "INBOX"
}
}
]
}
}
}
]
},
"getEmailToFax": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "emailToFax",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "id",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "0000"
}
},
{
"name": "enabled",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "email",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "<a href=\"/cdn-cgi/l/email-protection\" class=\"__cf_email__\" data-cfemail=\"daa3b5afa89abfb7bbb3b6f4b9b5b7\">[email protected]</a>"
}
},
{
"name": "security_code",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "12345"
}
},
{
"name": "security_code_enabled",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "from",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5552341234"
}
}
]
}
}
}
]
},
"mailFaxMessagePDF": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "message_status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "message_sent"
}
}
]
},
"moveFaxMessage": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"orderFaxNumber": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "dids",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "array("
}
},
{
"name": "0",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5552341234"
}
},
{
"name": "1",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5552341234"
}
},
{
"name": "2",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "5552341234 ..."
}
}
]
},
"setFaxFolder": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"setEmailToFax": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"searchFaxAreaCodeCAN": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "ratecenters",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "array("
}
},
{
"name": "0",
"shape": {
"kind": "object",
"fields": [
{
"name": "ratecenter",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "ACTON"
}
},
{
"name": "area_code",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "226"
}
},
{
"name": "available",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
}
]
}
}
]
},
"searchFaxAreaCodeUSA": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "ratecenters",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "array("
}
},
{
"name": "0",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "array("
}
},
{
"name": "ratecenter",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "COLD SPRING"
}
},
{
"name": "area_code",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "845"
}
},
{
"name": "available",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
}
]
},
"setFaxNumberInfo": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"setFaxNumberEmail": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"setFaxNumberURLCallback": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"sendFaxMessage": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"e911AddressTypes": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "types",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Array( Array ("
}
},
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"Apartment\","
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"Apartment\" ), Array ("
}
},
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"Basement\","
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"Basement\""
}
}
]
},
"e911Cancel": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"e911Info": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "info",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Array ("
}
},
{
"name": "did",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"7472127447\","
}
},
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"2\","
}
},
{
"name": "full_name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"test\","
}
},
{
"name": "street_number",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"23\","
}
},
{
"name": "street_name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"W BROAD ST\","
}
},
{
"name": "address_type",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"Hanger\","
}
},
{
"name": "address_number",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"401\","
}
},
{
"name": "city",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"RICHMOND\","
}
},
{
"name": "state",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"VA\","
}
},
{
"name": "zip_code",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"12345\","
}
},
{
"name": "country",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"US\","
}
},
{
"name": "language",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"EN\","
}
},
{
"name": "email",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"<a href=\"/cdn-cgi/l/email-protection\" class=\"__cf_email__\" data-cfemail=\"157f7a7d7b3b717a7055786c38717a78747c7b3b767a78\">[email protected]</a>\","
}
},
{
"name": "other_info",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"\""
}
}
]
},
"e911Provision": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"e911ProvisionManually": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"e911Update": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"e911Validate": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"addLNPPort": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "port",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "##### (Number ID of the created record)"
}
}
]
},
"addLNPFile": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "attachment",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "##### (Number ID of the created record)"
}
}
]
},
"getLNPListStatus": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "list_status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Array( \"status_code\" => \"Status Description\","
}
}
]
},
"getLNPList": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "list",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Array( Array ("
}
},
{
"name": "portid",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"0000\","
}
},
{
"name": "numbers",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"####,###\","
}
},
{
"name": "foc_date",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"2019-01-08\","
}
},
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"processing\" ), Array ("
}
},
{
"name": "portid",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"1111\","
}
},
{
"name": "numbers",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"####\","
}
},
{
"name": "foc_date",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "false,"
}
},
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"processing\""
}
}
]
},
"getLNPStatus": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "post_status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"pending_approval\""
}
},
{
"name": "post_status_description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"Pending Approval\""
}
}
]
},
"getLNPNotes": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "list",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Array( Array ("
}
},
{
"name": "note",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"You have submitted a new LNP Order. Current status is Pending Approval. A member of our staff will review your submission and update status accordingly.\","
}
},
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"2019-02-25\","
}
},
{
"name": "time",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"15:05:11\""
}
}
]
},
"getLNPAttach": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "type",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"pdf\","
}
},
{
"name": "size",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"151600\","
}
},
{
"name": "base64",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"Base64 Code\""
}
}
]
},
"getLNPAttachList": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "list",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Array( Array ("
}
},
{
"name": "attachid",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"000\","
}
},
{
"name": "type",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"pdf\","
}
},
{
"name": "size",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "\"151600\""
}
}
]
},
"createVoicemail": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delMessages": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delMemberFromConference": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"delVoicemail": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"getPlayInstructions": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "play_instructions",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "u"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "Yes"
}
}
]
}
}
}
]
},
"getTimezones": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "timezones",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "America/Buenos_Aires"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "America/Buenos Aires"
}
}
]
}
}
}
]
},
"getVoicemails": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "voicemails",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "mailbox",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1001"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "VoIP"
}
},
{
"name": "password",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1234"
}
},
{
"name": "skip_password",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "email",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "<a href=\"/cdn-cgi/l/email-protection\" class=\"__cf_email__\" data-cfemail=\"563c393e3878323933163b2f7b32393b373f387835393b\">[email protected]</a>"
}
},
{
"name": "attach_message",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "delete_message",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "say_time",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "timezone",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "America/Chicago"
}
},
{
"name": "say_callerid",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "play_instructions",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "su"
}
},
{
"name": "language",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "en"
}
},
{
"name": "email_attachment_format",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "wav49"
}
},
{
"name": "unavailable_message_recording",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "19183"
}
},
{
"name": "new",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "3"
}
},
{
"name": "urgent",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "transcription",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "transcription_locale",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "en-US"
}
},
{
"name": "transcription_redaction",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "transcription_sentiment",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "transcription_summary",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
},
{
"name": "transcription_format",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "text"
}
},
{
"name": "transcription_delay",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "0"
}
}
]
}
}
}
]
},
"getVoicemailFolders": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "folders",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "value",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "INBOX"
}
},
{
"name": "description",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "INBOX"
}
}
]
}
}
}
]
},
"getVoicemailMessageFile": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "message",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "mailbox",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1001"
}
},
{
"name": "folder",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "INBOX"
}
},
{
"name": "message_num",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "data",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "UklGRqTEAQBXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YYDEA...."
}
}
]
}
}
}
]
},
"getVoicemailMessages": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "messages",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "mailbox",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1001"
}
},
{
"name": "folder",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "INBOX"
}
},
{
"name": "message_num",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "date",
"shape": {
"kind": "scalar",
"type": "date",
"sample": "2016-01-30"
}
},
{
"name": "callerid",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "5551234567"
}
},
{
"name": "duration",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "00:00:06"
}
},
{
"name": "urgent",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "yes"
}
},
{
"name": "listened",
"shape": {
"kind": "scalar",
"type": "bool_yn",
"sample": "no"
}
}
]
}
}
}
]
},
"getVPRIs": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
},
{
"name": "vpri",
"shape": {
"kind": "list",
"element": {
"kind": "object",
"fields": [
{
"name": "vpri",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "100112"
}
},
{
"name": "name",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "main vpri"
}
},
{
"name": "note",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "Important notes"
}
},
{
"name": "channels",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "monthly_fee",
"shape": {
"kind": "scalar",
"type": "decimal",
"sample": "0.2"
}
},
{
"name": "next_billing",
"shape": {
"kind": "scalar",
"type": "date",
"sample": "2022-08-15"
}
},
{
"name": "burst_enabled",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
},
{
"name": "burst_max_channels",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "2"
}
},
{
"name": "burst_percentage_charge",
"shape": {
"kind": "scalar",
"type": "integer",
"sample": "1"
}
}
]
}
}
}
]
},
"markListenedVoicemailMessage": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"markUrgentVoicemailMessage": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"moveFolderVoicemailMessage": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"sendVoicemailEmail": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
},
"setVoicemail": {
"kind": "object",
"fields": [
{
"name": "status",
"shape": {
"kind": "scalar",
"type": "string",
"sample": "success"
}
}
]
}
},
"param_docs": {
"addMemberToConference": {
"member": "Specific Member ID (Example: 6547) (required)",
"conference": "Specific Conference ID (Example: 234) (required)"
},
"getBalance": {
"advanced": "True for Calls Statistics"
},
"getConference": {
"conference": "Code for a specific Conference (Example: 1599)"
},
"getConferenceMembers": {
"member": "Code for a specific Member profile (Example: 1599)"
},
"getConferenceRecordings": {
"conference": "ID for a specific Conference (Example: 5356) (required)",
"date_from": "Start Date for Filtering Transactions (Example: '2016-06-03')",
"date_to": "End Date for Filtering Transactions (Example: '2016-06-04')"
},
"getConferenceRecordingFile": {
"conference": "ID for a specific Conference (Example: 5356) (required)",
"recording": "ID for a specific Conference Recording (Example: 1543338379) (required)"
},
"getCountries": {
"country": "Code for a specific Country (Example: 'CA')"
},
"getLanguages": {
"language": "Code for a specific Language (Example: 'en')"
},
"getLocales": {
"locale": "Code for a specific Locale Code (Example: 'en-US')"
},
"getServersInfo": {
"server_pop": "POP for a specific Server (Example: 1)"
},
"getTransactionHistory": {
"date_from": "Start Date for Filtering Transactions (Example: '2016-06-03') (required)",
"date_to": "End Date for Filtering Transactions (Example: '2016-06-04') (required)"
},
"createSubAccount": {
"username": "Username for the Sub Account (Example: 'VoIP') (required)",
"protocol": "Protocol used for the Sub Account (Values from getProtocols) (required)",
"description": "Sub Account Description (Example: 'VoIP Account')",
"auth_type": "Authorization Type Code (Values from getAuthTypes) (required)",
"password": "Sub Account Password (For Password Authentication)",
"ip": "Sub Account IP (For IP Authentication)",
"device_type": "Device Type Code (Values from getDeviceTypes) (required)",
"callerid_number": "Caller ID Override",
"canada_routing": "Route Code (Values from getRoutes)",
"lock_international": "Lock International Code (Values from getLockInternational) (required)",
"allow225": "When Enabled, calls placed to *225 will provide the Current Balance of the VoIP.ms Account. When Disabled, calls placed to *225 will be rejected.",
"international_route": "Route Code (Values from getRoutes) (required)",
"music_on_hold": "Music on Hold Code (Values from getMusicOnHold) (required)",
"language": "Language for system messages, such as \"Invalid Option\" (Values from getLanguages)",
"record_calls": "Record Calls (Boolean: 1/0)",
"allowed_codecs": "List of Allowed Codecs (Values from getAllowedCodecs) Codecs separated by semicolon (Example: ulaw;g729;gsm) (required)",
"dtmf_mode": "DTMF Mode Code (Values from getDTMFModes) (required)",
"nat": "NAT Mode Code (Values from getNAT) (required)",
"sip_traffic": "Encrypted SIP Traffic (Boolean: 1/0)",
"max_expiry": "Max Expiry between 60 and 3600 (Example: 3000)",
"rtp_timeout": "RTP Time Out between 1 and 3600 (Example: 60)",
"rtp_hold_timeout": "RTP Hold Time Out between 1 and 3600 (Example: 600)",
"ip_restriction": "List of IP Addresses, IP Addresses/Netmask, or Fully Qualified Domain Names to allow outgoing calls separated by commas (Example: 123.45.3.21,10.255.12.0/22,device.mydomain.com)",
"enable_ip_restriction": "Enable IP Restriction (Boolean: 1/0)",
"pop_restriction": "List of POP Servers to allow outgoing calls separated by commas (values from getServersInfo. Example: 10,23,45)",
"enable_pop_restriction": "Enable POP Restriction (Boolean: 1/0)",
"send_bye": "Send BYE on successful transfer (Boolean: 1/0)",
"transcribe": "Enable Call Transcription (Boolean: 1/0)",
"transcription_locale": "Transcription locale code (values from getLocales, comma separated for more than one locale up to 10 locales)",
"transcription_redaction": "Transcription redaction (Values: 'yes'/'no')",
"transcription_summary": "Transcription summary (Values: 'yes'/'no')",
"transcription_sentiment": "Transcription sentiment (Values: 'yes'/'no')",
"transcription_email": "Call Transcription Email",
"internal_extension": "Sub Account Internal Extension (Example: 1 -> Creates 101)",
"internal_voicemail": "Sub Account Internal Voicemail (Example: 101)",
"internal_dialtime": "Sub Account Internal Dialtime (Example: 60 -> seconds)",
"reseller_client": "Reseller Account ID (Example: 561115)",
"reseller_package": "Reseller Package (Example: 92364)",
"reseller_nextbilling": "Reseller Next Billing Date (Example: '2012-12-31')",
"reseller_chargesetup": "True if you want to charge Package Setup Fee after Save",
"parking_lot": "ID for a specific Call Parking (Example: 323)",
"transcription_start_delay": "Call Transcription Delay Seconds between 0 and 60, Increments of 5 (Example: 10 -> seconds)",
"enable_internal_cnam": "Enable Internal CallerID",
"internal_cnam": "Internal CallerID Name",
"default_e911": "e911 Default CallerID",
"call_pickup_behavior": "1 Can Pick Up and Be Picked Up, 2 Can Pick Up (Can 't be Picked Up), 3 Can Be Picked Up (Can't Pick Up), 4 Disabled (Can't Pick Up nor Get Picked Up)",
"dialing_mode": "Allows you to dial outgoing calls using either the NANPA configuration or the E164 configuration. (Values: 0 = Use Main Account Setting, 1 = E164, 2 = NANPA)",
"tfcarrier": "This allows you to select the carrier to be used for outgoing calls to toll-free numbers. (Values: -1 = Use main account settings, 0 = Default server setting, 1 = US carrier, 2 = Canadian carrier)",
"internal_extension_location": "Location group for the internal extension (Values from getLocations)"
},
"delSubAccount": {
"id": "ID for a specific Sub Account (Example: 99785)"
},
"getAllowedCodecs": {
"codec": "Code for a specific Codec (Example: 'ulaw')"
},
"getAuthTypes": {
"type": "Code for a specific Authorization Type (Example: 2)"
},
"getDeviceTypes": {
"device_type": "Code for a specific Device Type (Example: 1)"
},
"getDTMFModes": {
"dtmf_mode": "Code for a specific DTMF Mode (Example: 'inband')"
},
"getLockInternational": {
"lock_international": "Code for a specific Lock International Mode (Example: 1)"
},
"getMusicOnHold": {
"music_on_hold": "Code for a specific Music on Hold (Example: 'jazz')"
},
"setMusicOnHold": {
"name": "Music on Hold Name (Values from getMusicOnHold)",
"description": "Music on Hold Description (required)",
"volume": "Music on Hold Quiet Volume (Boolean: 1/0)",
"sort": "Selected recordings sort mode (Example: \"alpha\", \"random\")",
"recordings": "Selected recordings separated by commas (Values from getRecordings, example: (1234,1235,1236) (required)"
},
"delMusicOnHold": {
"music_on_hold": "Music on Hold Name (Values from getMusicOnHold) (required)"
},
"getNAT": {
"nat": "Code for a specific NAT Option (Example: 'route')"
},
"getProtocols": {
"protocol": "Code for a specific Protocol (Example: 3)"
},
"getRegistrationStatus": {
"account": "Specific Account (Example: '100001_VoIP') (required)"
},
"getReportEstimatedHoldTime": {
"type": "Code for a specific 'ReportEstimatedHoldTime' Type (Example: 'yes')"
},
"getRoutes": {
"route": "Code for a specific Route (Example: 2)"
},
"getSubAccounts": {
"account": "Parameter could have the following values: * Empty Value [Not Required] * Specific Sub Account (Example: '100000_VoIP') * Specific Reseller Client ID (Example: 561115)"
},
"getCallTranscriptions": {
"account": "Specific Account (Example: '100001_VoIP') (required)",
"date_from": "Start Date for Filtering (Example: '2010-11-30') (required)",
"date_to": "End Date for Filtering (Example: '2010-11-30') (required)",
"call_type": "Filters by Call Type (Values from getCallTypes)"
},
"getVoicemailTranscriptions": {
"date_from": "Start Date for Filtering (Example: '2010-11-30') (required)",
"date_to": "End Date for Filtering (Example: '2010-11-30') (required)",
"mailbox": "ID for specific Mailbox (Example: 1001) (required)",
"folder": "Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders) (required)"
},
"setSubAccount": {
"id": "Sub Account ID (Example: 10236) (required)",
"description": "Sub Account Description (Example: 'VoIP Account')",
"auth_type": "Authorization Type Code (Values from getAuthTypes) (required)",
"password": "Sub Account Password (For Password Authentication)",
"ip": "Sub Account IP (For IP Authentication)",
"device_type": "Device Type Code (Values from getDeviceTypes) (required)",
"callerid_number": "Caller ID Override",
"canada_routing": "Route Code (Values from getRoutes)",
"lock_international": "Lock International Code (Values from getLockInternational) (required)",
"allow225": "When Enabled, calls placed to *225 will provide the Current Balance of the VoIP.ms Account. When Disabled, calls placed to *225 will be rejected.",
"international_route": "Route Code (Values from getRoutes) (required)",
"music_on_hold": "Music on Hold Code (Values from getMusicOnHold) (required)",
"language": "Language for system messages, such as \"Invalid Option\" (Values from getLanguages)",
"record_calls": "Record Calls (Boolean: 1/0)",
"allowed_codecs": "List of Allowed Codecs (Values from getAllowedCodecs) Codecs separated by semicolon (Example: ulaw;g729;gsm) (required)",
"dtmf_mode": "DTMF Mode Code (Values from getDTMFModes) (required)",
"nat": "NAT Mode Code (Values from getNAT) (required)",
"sip_traffic": "Encrypted SIP Traffic (Boolean: 1/0)",
"max_expiry": "Max Expiry between 60 and 3600 (Example: 3000)",
"rtp_timeout": "RTP Time Out between 1 and 3600 (Example: 60)",
"rtp_hold_timeout": "RTP Hold Time Out between 1 and 3600 (Example: 600)",
"ip_restriction": "List of IP/Netmask to allow outgoing calls separated by commas (Example: 123.45.3.21,10.255.12.0/22,device.mydomain.com)",
"enable_ip_restriction": "Enable IP Restriction (Boolean: 1/0)",
"pop_restriction": "List of POP Servers to allow outgoing calls separated by commas (values from getServersInfo. Example: 10,23,45)",
"enable_pop_restriction": "Enable POP Restriction (Boolean: 1/0)",
"send_bye": "Send BYE on successful transfer (Boolean: 1/0)",
"internal_extension": "Sub Account Internal Extension (Example: 1 -> Creates 101)",
"internal_voicemail": "Sub Account Internal Voicemail (Example: 101)",
"internal_dialtime": "Sub Account Internal Dialtime (Example: 60 -> seconds)",
"reseller_client": "Reseller Account ID (Example: 561115)",
"reseller_package": "Reseller Package (Example: 92364)",
"reseller_nextbilling": "Reseller Next Billing Date (Example: '2012-12-31')",
"reseller_chargesetup": "True if you want to charge Package Setup Fee after Save",
"parking_lot": "ID for a specific Call Parking (Example: 323)",
"transcription_start_delay": "Call Transcription Delay Seconds between 0 and 60, Increments of 5 (Example: 10 -> seconds)",
"enable_internal_cnam": "Enable Internal CallerID",
"internal_cnam": "Internal CallerID Name",
"default_e911": "e911 Default CallerID",
"call_pickup_behavior": "1 Can Pick Up and Be Picked Up, 2 Can Pick Up (Can 't be Picked Up), 3 Can Be Picked Up (Can't Pick Up), 4 Disabled (Can't Pick Up nor Get Picked Up)",
"dialing_mode": "Allows you to dial outgoing calls using either the NANPA configuration or the E164 configuration. (Values: 0 = Use Main Account Setting, 1 = E164, 2 = NANPA)",
"tfcarrier": "This allows you to select the carrier to be used for outgoing calls to toll-free numbers. (Values: -1 = Use main account settings, 0 = Default server setting, 1 = US carrier, 2 = Canadian carrier)",
"internal_extension_location": "Location group for the internal extension (Values from getLocations)"
},
"setLocation": {
"name": "Internal Extension Location name (Example: \"Location1\") (required)"
},
"delLocation": {
"name": "Internal Extension Location name (Value from getLocations) (required)",
"id": "Internal Extension Location id (Value from getLocations\") (required)"
},
"getCallParking": {
"callparking": "ID for a specific Call Parking (Example: 737)"
},
"setCallParking": {
"callparking": "ID for a specific Call Parking (Example: 235 / Leave empty to create a new one)",
"name": "Name for the Call Parking (required)",
"timeout": "The number of seconds a call will stay parked before it is forwarded to the Failover Destination (required)",
"music": "Music on Hold Code (Values from getMusicOnHold) (required)",
"failover": "Final destination where the call will be forwarded if it isn’t answered. (Values: callback, system:hangup, vm:mailbox) (required)",
"language": "Language for the Call Parking (values from getLanguages) (required)",
"destination": "The system will make an automatic call to this destination to announce the extension of the parked call. (Values: parker, main account or sub-accounts) (required)",
"delay": "The number of seconds before the Announce Destination receives an automatic call from the system to announce the extension of the parked call (required)",
"blf_lamps": "You can enable BLF for your Parking Lot and select the amount of BLF Lamps that you require. (Values: 0 to 10) (required)"
},
"delCallParking": {
"callparking": "ID for a specific Call Parking (Example: 323) (required)"
},
"getCallRecordings": {
"account": "Filter Call Recordings by Account (Values from getCallAccounts) (required)",
"start": "Number of records shown previously, used for pages",
"length": "Number of records to show",
"date_from": "Start Date for Filtering Call Recording (Example:'2018-11-01') (required)",
"date_to": "End Date for Filtering Call Recording (Example:'2018-12-01') (required)",
"call_type": "Call Type for Filtering Call Recording (Accepted values: 'all', 'incoming' and 'outgoing')"
},
"getCallRecording": {
"account": "Main Account or Sub Account related to the call recording (Values from getCallRecordings) (required)",
"callrecording": "Call Recording (Values from getCallRecordings) (required)"
},
"sendCallRecordingEmail": {
"account": "Filter Call Recordings by Account (Values from getCallAccounts) (required)",
"email": "Email to send call recording (required)",
"callrecording": "Call Recording (Values from getCallRecordings) (required)"
},
"delCallRecording": {
"account": "Filter Call Recordings by Account (Values from getCallAccounts) (required)",
"callrecording": "Call Recording (Values from getCallRecordings) (required)"
},
"getCallAccounts": {
"client": "ID for a specific Reseller Client (Example: 561115)"
},
"getCallTypes": {
"client": "ID for a specific Reseller Client (Example: 561115)"
},
"getCDR": {
"date_from": "Start Date for Filtering CDR (Example: '2010-11-30') (required)",
"date_to": "End Date for Filtering CDR (Example: '2010-11-30') (required)",
"answered": "Include Answered Calls to CDR (Boolean: 1/0)",
"noanswer": "Include NoAnswered calls to CDR (Boolean: 1/0)",
"busy": "Include Busy Calls to CDR (Boolean: 1/0)",
"failed": "Include Failed Calls to CDR (Boolean: 1/0)",
"timezone": "Adjust time of calls according to Timezome (Numeric: -12 to 13) (required)",
"calltype": "Filters CDR by Call Type (Values from getCallTypes)",
"callbilling": "Filter CDR by Call Billing (Values from getCallBilling)",
"account": "Filter CDR by Account (Values from getCallAccounts)"
},
"getRates": {
"package": "ID for a specific Package (Example: 92364) (required)",
"query": "Query for searching rates (Example: 'Canada') (required)"
},
"getTerminationRates": {
"route": "Route Code (Values from getRoutes)(Example: '2') (required)",
"query": "Query for searching rates (Example: 'Canada') (required)"
},
"getResellerCDR": {
"date_from": "Start Date for Filtering CDR (Example: '2010-11-30') (required)",
"date_to": "End Date for Filtering CDR (Example: '2010-11-30') (required)",
"client": "ID for a specific Reseller Client (Example: 561115) (required)",
"answered": "Include Answered Calls to CDR (Boolean: 1/0)",
"noanswer": "Include NoAnswered calls to CDR (Boolean: 1/0)",
"busy": "Include Busy Calls to CDR (Boolean: 1/0)",
"failed": "Include Failed Calls to CDR (Boolean: 1/0)",
"timezone": "Adjust time of calls according to Timezome (Numeric: -12 to 13) (required)",
"calltype": "Filters CDR by Call Type (Values from getCallTypes)",
"callbilling": "Filter CDR by Call Billing (Values from getCallBilling)",
"account": "Filter CDR by Account (Values from getCallAccounts)"
},
"getResellerSMS": {
"sms": "ID for a specific SMS (Example: 5853)",
"from": "Start Date for Filtering SMSs (Example: '2014-03-30') - Default value: Today",
"to": "End Date for Filtering SMSs (Example: '2014-03-30') - Default value: Todayclient => [Required] ID for a specific Reseller Client (Example: 561115)",
"type": "Filter SMSs by Type (Boolean: 1 = received / 0 = sent)",
"did": "DID number for Filtering SMSs (Example: 5551234567)",
"contact": "Contact number for Filtering SMSs (Example: 5551234567)",
"limit": "Number of records to be displayed (Example: 20) - Default value: 50",
"timezone": "Adjust time of SMSs according to Timezome (Numeric: -12 to 13)",
"all_messages": "Filter to recive all SMSs and MMSs, 1 recive all SMS and MMS, 0 if only need SMS, important: the sms ID must be 0"
},
"getResellerMMS": {
"sms": "ID for a specific MMS (Example: 5853)",
"from": "Start Date for Filtering SMSs (Example: '2014-03-30') - Default value: Today",
"to": "End Date for Filtering MMSs (Example: '2014-03-30') - Default value: Todayclient => [Required] ID for a specific Reseller Client (Example: 561115)",
"type": "Filter SMSs by Type (Boolean: 1 = received / 0 = sent)",
"did": "DID number for Filtering MMSs (Example: 5551234567)",
"contact": "Contact number for Filtering MMSs (Example: 5551234567)",
"limit": "Number of records to be displayed (Example: 20) - Default value: 50",
"timezone": "Adjust time of MMSs according to Timezome (Numeric: -12 to 13)",
"all_messages": "Filter to recive all SMSs and MMSs, 1 recive all SMS and MMS, 0 if only need SMS, important: the sms ID must be 0"
},
"addCharge": {
"client": "ID for a specific Reseller Client (Example: 561115) (required)",
"charge": "Amount of money that will be Debited from the customer (Example: 4.99) (required)",
"description": "Charge Description",
"test": "Set to true if testing how adding charges works"
},
"addPayment": {
"client": "ID for a specific Reseller Client (Example: 561115) (required)",
"payment": "Amount of money that will be Credited to the customer (Example: 4.99) (required)",
"description": "Payment Description",
"test": "Set to true if testing how adding payments works"
},
"assignDIDvPRI": {
"did": "DID Number to be assign into our Vpri (Example: 561115) (required)",
"vpri": "Id for specific Vpri (required)"
},
"getBalanceManagement": {
"balance_management": "Code for a specific Balance Management Setting (Example: 1)"
},
"getCharges": {
"client": "ID for a specific Reseller Client (Example: 561115) (required)"
},
"getClientPackages": {
"client": "ID for a specific Reseller Client (Example: 561115) (required)"
},
"getClients": {
"client": "Parameter could have the following values: * Empty Value [Not Required] * Specific Reseller Client ID (Example: 561115) * Specific Reseller Client e-mail (Example: '[email protected]')"
},
"getClientThreshold": {
"client": "ID for a specific Reseller Client (Example: 561115) (required)"
},
"getDeposits": {
"client": "ID for a specific Reseller Client (Example: 561115) (required)"
},
"getPackages": {
"package": "Code for a specific Package (Example: 8378)"
},
"getResellerBalance": {
"client": "ID for a specific Reseller Client (Example: 561115) (required)"
},
"setClient": {
"client": "ID for a specific Reseller Client (Example: 561115) (required)",
"email": "Client's e-mail (required)",
"password": "Client's Password (required)",
"company": "Client's Company",
"firstname": "Client's Firstname (required)",
"lastname": "Client's Lastname (required)",
"address": "Client's Address",
"city": "Client's City",
"state": "Client's State",
"country": "Client's Country (Values from getCountries)",
"zip": "Client's Zip Code",
"phone_number": "Client's Phone Number (required)",
"balance_management": "Balance Management for Client (Values from getBalanceManagement)"
},
"setClientThreshold": {
"client": "ID for a specific Reseller Client (Example: 561115) (required)",
"threshold": "Threshold amount between 1 and 250 (Example: 10) (required)",
"email": "Client's e-mail for balance threshold notification"
},
"setConference": {
"conference": "ID for a specific Conference (Example: 5356) (required)",
"name": "Conference name (required)",
"description": "Conference description (required)",
"members": "Conference Members",
"max_members": "Members Max Value (required)",
"sound_join": "The recording played when a user joins, typically some kind of beep sound (Values from getRecordings)",
"sound_leave": "The recording played when a user leaves, typically some kind of beep sound (Values from getRecordings)",
"sound_has_joined": "The recording played as a user intro (Values from getRecordings)",
"sound_has_left": "The recording played as a user leaves the conference (Values from getRecordings)",
"sound_kicked": "The recording played to a user who has been kicked from the conference (Values from getRecordings)",
"sound_muted": "The recording played to a user when the mute option is toggled on (Values from getRecordings)",
"sound_unmuted": "The recording played to a user when the mute option is toggled off (Values from getRecordings)",
"sound_only_person": "The recording played when a user is the only person in the conference (Values from getRecordings)",
"sound_only_one": "The recording played to a user when there is only one other person in the conference. (Values from getRecordings)",
"sound_there_are": "The recording played when announcing how many users there are in a conference. (Values from getRecordings)",
"sound_other_in_party": "The recording used in conjunction with the There are option, used like There are (number of participants) Other in party (Values from getRecordings)",
"sound_place_into_conference": "The recording played when a user is placed into a conference that cannot start until a marked user enters (Values from getRecordings)",
"sound_get_pin": "The recording played when prompting for a conference PIN (Values from getRecordings)",
"sound_invalid_pin": "The recording played when an invalid PIN is entered too many (3) times (Values from getRecordings)",
"sound_locked": "The recording played to a user trying to join a locked conference (Values from getRecordings)",
"sound_locked_now": "The recording played to an Admin-level user after toggling the conference to locked mode (Values from getRecordings)",
"sound_unlocked_now": "The recording played to an Admin-level user after toggling the conference to unlocked mode (Values from getRecordings)",
"sound_error_menu": "The recording played when there is an error on the menu. (Values from getRecordings)",
"sound_participants_muted": "The recording played when all non-admin participants are muted. (Values from getRecordings)",
"sound_participants_unmuted": "The recording played when all non-admin participants are unmuted. (Values from getRecordings)",
"language": "Conference Language (Values from getLanguages)"
},
"setConferenceMember": {
"conference": "ID for a specific Conference (Example: 5356) (required)",
"member": "ID for a specific Member profile (Example: 5356) (required)",
"name": "Member name. (required)",
"description": "Member description.",
"pin": "Assigned PIN.",
"announce_join_leave": "Sets if the conference recording when a member joins or leaves will be played (yes/no).",
"admin": "Sets if the member is an admin or not (yes/no).",
"start_muted": "Sets if the member should start out muted after entering the conference (yes/no).",
"announce_user_count": "Sets if the number of members in the conference should be announced to the caller as he joins (yes/no).",
"announce_only_user": "Sets if the \"only user\" announcement should be played when a caller enters an empty conference (yes/no).",
"moh_when_empty": "Sets whether music on hold (MOH) should be played when only one person is in the conference (Values from getMusicOnHold).",
"quiet": "When set to \"yes\", enter/leave prompts and user introductions are not played (yes/no).",
"announcement": "If set, this recording will be heard only by the user as he joins the conference (Values from getRecordings).",
"drop_silence": "The system will drop what is detected as silence from entering into the conference (yes/no).",
"talking_threshold": "The time, in milliseconds, that a users needs to be sending sound or voice before the system can consider them to be talking (allowed values are 100, 120, 140, 160, 180, 200, 220, 240 or 250).",
"silence_threshold": "The time, in milliseconds, that silence needs to be present in the user’s sound stream before the system can consider it to be in fact silent and close the audio (allowed values are 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900 or 3000).",
"talk_detection": "If set to YES, the conference dashboard will display a notification when a participant starts and stops talking (yes/no).",
"jitter_buffer": "When set to YES, the system will place a jitter buffer on the caller's audio stream before any audio mixing is performed (yes/no)."
},
"signupClient": {
"firstname": "Client's Firstname (required)",
"lastname": "Client's Lastname (required)",
"company": "Client's Company",
"address": "Client's Address (required)",
"city": "Client's City (required)",
"state": "Client's State (required)",
"country": "Client's Country (Values from getCountries) (required)",
"zip": "Client's Zip Code (required)",
"phone_number": "Client's Phone Number (required)",
"email": "Client's e-mail (required)",
"confirm_email": "Client's Confirmation e-mail (required)",
"password": "Client's Password (required)",
"confirm_password": "Client's Confirmation Password (required)",
"activate": "Activates Client (Boolean: 1/0)",
"balance_management": "Balance Management for Client (Values from getBalanceManagement)"
},
"backOrderDIDUSA": {
"quantity": "Number of DIDs to be Ordered (Example: 3) (required)",
"state": "USA State (values from getStates) (required)",
"ratecenter": "USA Ratecenter (Values from getRateCentersUSA) (required)",
"routing": "Main Routing for the DID (required)",
"failover_busy": "Busy Routing for the DID",
"failover_unreachable": "Unreachable Routing for the DID",
"failover_noanswer": "NoAnswer Routing for the DID",
"voicemail": "Voicemail for the DID (Example: 101)",
"pop": "Point of Presence for the DID (Example: 5) (required)",
"dialtime": "Dial Time Out for the DID (Example: 60 -> in seconds) (required)",
"cnam": "CNAM for the DID (Boolean: 1/0) (required)",
"callerid_prefix": "Caller ID Prefix for the DID",
"note": "Note for the DID",
"billing_type": "Billing type for the DID (1 = Per Minute, 2 = Flat) (required)",
"test": "Set to true if testing how Orders work - Orders can not be undone - When testing, no Orders are made routing, failover_busy, failover_unreachable and failover_noanswer can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function sys System Options: hangup = Hangup the Call busy = Busy tone noservice = System Recording: Number not in service disconnected = System Recording: Number has been disconnected dtmf = DTMF Test echo = Sound Quality Test none Used to route calls to no action Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101' 'none:' 'sys:echo'"
},
"backOrderDIDCAN": {
"quantity": "Number of DIDs to be Ordered (Example: 3) (required)",
"province": "Canadian Province (values from getProvinces) (required)",
"ratecenter": "USA Ratecenter (Values from getRateCentersUSA) (required)",
"routing": "Main Routing for the DID (required)",
"failover_busy": "Busy Routing for the DID",
"failover_unreachable": "Unreachable Routing for the DID",
"failover_noanswer": "NoAnswer Routing for the DID",
"voicemail": "Voicemail for the DID (Example: 101)",
"pop": "Point of Presence for the DID (Example: 5) (required)",
"dialtime": "Dial Time Out for the DID (Example: 60 -> in seconds) (required)",
"cnam": "CNAM for the DID (Boolean: 1/0) (required)",
"callerid_prefix": "Caller ID Prefix for the DID",
"note": "Note for the DID",
"billing_type": "Billing type for the DID (1 = Per Minute, 2 = Flat) (required)",
"test": "Set to true if testing how Orders work - Orders can not be undone - When testing, no Orders are made routing, failover_busy, failover_unreachable and failover_noanswer can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function sys System Options: hangup = Hangup the Call busy = Busy tone noservice = System Recording: Number not in service disconnected = System Recording: Number has been disconnected dtmf = DTMF Test echo = Sound Quality Test none Used to route calls to no action Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101' 'none:' 'sys:echo'"
},
"cancelDID": {
"did": "DID to be canceled and deleted (Example: 5551234567) (required)",
"cancelcomment": "Comment for DID cancellation",
"portout": "Set to true if the DID is being ported out",
"test": "Set to true if testing how cancellation works - Cancellation can not be undone - When testing, no changes are made"
},
"connectDID": {
"did": "DID to be Connected to Reseler Sub Account (Example: 5551234567) (required)",
"account": "Reseller Sub Account (Example: '100001_VoIP') (required)",
"monthly": "Montly Fee for Reseller Client (Example: 3.50) (required)",
"setup": "Setup Fee for Reseller Client (Example: 1.99) (required)",
"minute": "Minute Rate for Reseller Client (Example: 0.03) (required)",
"next_billing": "Next billing date (Example: '2014-03-30')",
"dont_charge_setup": "If set to true, the setup value will not be charged after Connect",
"dont_charge_monthly": "If set to true, the monthly value will not be charged after Connect"
},
"delCallback": {
"callback": "ID for a specific Callback (Example: 19183) (required)"
},
"delCallerIDFiltering": {
"filtering": "ID for a specific CallerID Filtering (Example: 19183) (required)"
},
"delCallHunting": {
"callhunting": "ID for a specific Call Hunting (Example: 323) (required)"
},
"delClient": {
"client": "ID for a specific Reseller Client (Example: 1998) (required)"
},
"delConference": {
"conference": "ID for a specific Conference (Example: 737) (required)"
},
"delConferenceMember": {
"member": "ID for a specific Member Profile (Example: 737) (required)"
},
"delDISA": {
"disa": "ID for a specific DISA (Example: 19183) (required)"
},
"deleteSMS": {
"id": "ID for a specific SMS (Example: 1918) (required)"
},
"deleteMMS": {
"id": "ID for a specific MMS (Example: 1918) (required)"
},
"delForwarding": {
"forwarding": "ID for a specific Forwarding (Example: 19183)"
},
"delIVR": {
"ivr": "ID for a specific IVR (Example: 19183) (required)"
},
"delPhonebook": {
"phonebook": "ID for a specific Phonebook (Example: 19183) (required)"
},
"delPhonebookGroup": {
"group": "ID for a specific Phonebook group (required)"
},
"delQueue": {
"queue": "ID for a specific Queue (Example: 13183) (required)"
},
"delRecording": {
"recording": "ID for a specific Recording (Example: 19183) (required)"
},
"delRingGroup": {
"ringgroup": "ID for a specific Ring Group (Example: 19183) (required)"
},
"delSIPURI": {
"sipuri": "ID for a specific SIP URI (Example: 19183) (required)"
},
"delStaticMember": {
"member": "ID for a specific Member Queue (Example: 1918) (required)",
"queue": "ID for a specific Queue (Example: 27183) (required)"
},
"delTimeCondition": {
"timecondition": "ID for a specific Time Condition (Example: 19183) (required)"
},
"getCallbacks": {
"callback": "ID for a specific Callback (Example: 2359)"
},
"getCallerIDFiltering": {
"filtering": "ID for a specific CallerID Filtering (Example: 18915)",
"did": "DID for a specific CallerID Filtering (Example: 5551234567)"
},
"getCallHuntings": {
"callhunting": "ID for a specific Call Hunting (Example: 323)"
},
"getDIDCountries": {
"country_id": "ID for a specific country (Example: 205)",
"type": "Type of International DID (Values from getInternationalTypes) (required)"
},
"getCarriers": {
"carrier": "Code for a specific Carrier (Example: 2)"
},
"getDIDsCAN": {
"province": "Canadian Province (Values from getProvinces) (required)",
"ratecenter": "Canadian Ratecenter (Values from getRateCentersCAN)"
},
"getDIDsInfo": {
"client": "Parameter could have the following values: * Empty Value [Not Required] * Specific Reseller Client ID (Example: 561115) * Specific Sub Account (Example: '100001_VoIP')",
"did": "DID from Client or Sub Account (Example: 5551234567)"
},
"getDIDsInternationalGeographic": {
"country_id": "ID for a specific Country (Values from getDIDCountries) (required)"
},
"getDIDsInternationalNational": {
"country_id": "ID for a specific Country (Values from getDIDCountries) (required)"
},
"getDIDsInternationalTollFree": {
"country_id": "ID for a specific Country (Values from getDIDCountries) (required)"
},
"getDIDsUSA": {
"state": "United States State (Values from getStates) (required)",
"ratecenter": "United States Ratecenter (Values from getRateCentersUSA)"
},
"getDIDvPRI": {
"vpri": "Id for specific Vpri (required)"
},
"getDISAs": {
"disa": "ID for a specific DISA (Example: 2114)"
},
"getForwardings": {
"forwarding": "ID for a specific Forwarding (Example: 18635)"
},
"getInternationalTypes": {
"type": "Code for a specific International Type (Example: 'NATIONAL')"
},
"getIVRs": {
"ivr": "ID for a specific IVR (Example: 4636)"
},
"getJoinWhenEmptyTypes": {
"type": "Code for a specific 'JoinWhenEmpty' Type (Example: 'yes')"
},
"getPhonebook": {
"phonebook": "ID for a specific Phonebook entry (Example: 32207)",
"name": "Name to be searched in database (Example: 'jane')",
"group": "ID for a specific Phonebook group",
"group_name": "Group Name"
},
"getPhonebookGroups": {
"group": "ID for a specific Phonebook group",
"name": "Group Name"
},
"getPortability": {
"did": "DID Number to be ported into our network (Example: 5552341234) (required)"
},
"getRecordings": {
"recording": "ID for a specific Recording (Example: 7567)"
},
"getRecordingFile": {
"recording": "ID for a specific Recording (Example: 7567) (required)"
},
"getRingGroups": {
"ring_group": "ID for a specific Ring Group (Example: 4768)"
},
"getRingStrategies": {
"strategy": "ID for a specific Ring Strategy (Example: 'rrmemory')"
},
"getSIPURIs": {
"sipuri": "ID for a specific SIP URI (Example: 6199)"
},
"getSMS": {
"sms": "ID for a specific SMS (Example: 5853)",
"from": "Start Date for Filtering SMSs (Example: '2014-03-30') - Default value: Today",
"to": "End Date for Filtering SMSs (Example: '2014-03-30') - Default value: Today",
"type": "Filter SMSs by Type (Boolean: 1 = received / 0 = sent)",
"did": "DID number for Filtering SMSs (Example: 5551234567)",
"contact": "Contact number for Filtering SMSs (Example: 5551234567)",
"limit": "Number of records to be displayed (Example: 20) - Default value: 50",
"timezone": "Adjust time of SMSs according to Timezome (Numeric: -12 to 13)",
"all_messages": "Filter to recive all SMSs and MMSs, 1 recive all SMS and MMS, 0 if only need SMS, important: the sms ID must be 0"
},
"getMMS": {
"mms": "ID for a specific MMS (Example: 1918)",
"from": "Start Date for Filtering MMSs (Example: '2014-03-30') - Default value: Today",
"to": "End Date for Filtering MMSs (Example: '2014-03-30') - Default value: Today",
"type": "Filter MMSs by Type (Boolean: 1 = received / 0 = sent)",
"did": "DID number for Filtering MMSs (Example: 5551234567)",
"contact": "Contact number for Filtering MMSs (Example: 5551234567)",
"limit": "Number of records to be displayed (Example: 20) - Default value: 50",
"timezone": "Adjust time of MMSs according to Timezome (Numeric: -12 to 13)",
"all_messages": "Filter to recive all MMSs and SMSs, 1 recive all SMS and MMS, 0 if only need MMS, important: the sms ID must be 0"
},
"getMediaMMS": {
"id": "ID for a specific MMS (Example: 1918)",
"media_as_array": "Return the list of media attachments as an Array if the value is 1 or as a JSON Object if the value is 0 (Default: 0)"
},
"getQueues": {
"queue": "ID for a specific Queue (Example: 4764)"
},
"getRateCentersCAN": {
"province": "Canadian Province (Values from getProvinces) (required)"
},
"getRateCentersUSA": {
"state": "United States State (Values from getStates) (required)"
},
"getStaticMembers": {
"queue": "ID for a specific Queue (Example: 4136) (required)",
"member": "ID for a specific Static Member (Example: 163) - The Member must belong to the queue provided"
},
"getTimeConditions": {
"timecondition": "ID for a specific Time Condition (Example: 1830)"
},
"getVoicemailSetups": {
"voicemailsetup": "ID for a specific Voicemail Setup (Example: 2)"
},
"getVoicemailAttachmentFormats": {
"email_attachment_format": "ID for a specific attachment format (Example: wav49)"
},
"orderDID": {
"did": "DID to be Ordered (Example: 5552223333) (required)",
"routing": "Main Routing for the DID (required)",
"failover_busy": "Busy Routing for the DID",
"failover_unreachable": "Unreachable Routing for the DID",
"failover_noanswer": "NoAnswer Routing for the DID",
"voicemail": "Voicemail for the DID (Example: 101)",
"pop": "Point of Presence for the DID (Example: 5) (required)",
"dialtime": "Dial Time Out for the DID (Example: 60 -> in seconds) (required)",
"cnam": "CNAM for the DID (Boolean: 1/0) (required)",
"callerid_prefix": "Caller ID Prefix for the DID",
"note": "Note for the DID",
"billing_type": "Billing type for the DID (1 = Per Minute, 2 = Flat) (required)",
"account": "Reseller Sub Account (Example: '100001_VoIP')",
"monthly": "Montly Fee for Reseller Client (Example: 3.50)",
"setup": "Setup Fee for Reseller Client (Example: 1.99)",
"minute": "Minute Rate for Reseller Client (Example: 0.03)",
"test": "Set to true if testing how Orders work - Orders can not be undone - When testing, no Orders are made routing, failover_busy, failover_unreachable and failover_noanswer can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function sys System Options: hangup = Hangup the Call busy = Busy tone noservice = System Recording: Number not in service disconnected = System Recording: Number has been disconnected dtmf = DTMF Test echo = Sound Quality Test none Used to route calls to no action Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101' 'none:' 'sys:echo'"
},
"orderDIDInternationalGeographic": {
"location_id": "ID for a specific International Location (Values from getDIDsInternationalGeographic) (required)",
"quantity": "Number of dids to be purchased (Example: 2) (required)",
"routing": "Main Routing for the DID (required)",
"failover_busy": "Busy Routing for the DID",
"failover_unreachable": "Unreachable Routing for the DID",
"failover_noanswer": "NoAnswer Routing for the DID",
"voicemail": "Voicemail for the DID (Example: 101)",
"pop": "Point of Presence for the DID (Example: 5) (required)",
"dialtime": "Dial Time Out for the DID (Example: 60 -> in seconds) (required)",
"cnam": "CNAM for the DID (Boolean: 1/0) (required)",
"callerid_prefix": "Caller ID Prefix for the DID",
"billing_type": "Billing type for the DID (1 = Per Minute, 2 = Flat) (required)",
"note": "Note for the DID",
"account": "Reseller Sub Account (Example: '100001_VoIP')",
"monthly": "Montly Fee for Reseller Client (Example: 3.50)",
"setup": "Setup Fee for Reseller Client (Example: 1.99)",
"minute": "Minute Rate for Reseller Client (Example: 0.03)",
"test": "Set to true if testing how Orders work - Orders can not be undone - When testing, no Orders are made routing, failover_busy, failover_unreachable and failover_noanswer can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function sys System Options: hangup = Hangup the Call busy = Busy tone noservice = System Recording: Number not in service disconnected = System Recording: Number has been disconnected dtmf = DTMF Test echo = Sound Quality Test none Used to route calls to no action Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101' 'none:' 'sys:echo'"
},
"orderDIDInternationalNational": {
"location_id": "ID for a specific International Location (Values from getDIDsInternationalNational) (required)",
"quantity": "Number of dids to be purchased (Example: 2) (required)",
"routing": "Main Routing for the DID (required)",
"failover_busy": "Busy Routing for the DID",
"failover_unreachable": "Unreachable Routing for the DID",
"failover_noanswer": "NoAnswer Routing for the DID",
"voicemail": "Voicemail for the DID (Example: 101)",
"pop": "Point of Presence for the DID (Example: 5) (required)",
"dialtime": "Dial Time Out for the DID (Example: 60 -> in seconds) (required)",
"cnam": "CNAM for the DID (Boolean: 1/0) (required)",
"callerid_prefix": "Caller ID Prefix for the DID",
"billing_type": "Billing type for the DID (1 = Per Minute, 2 = Flat) (required)",
"note": "Note for the DID",
"account": "Reseller Sub Account (Example: '100001_VoIP')",
"monthly": "Montly Fee for Reseller Client (Example: 3.50)",
"setup": "Setup Fee for Reseller Client (Example: 1.99)",
"minute": "Minute Rate for Reseller Client (Example: 0.03)",
"test": "Set to true if testing how Orders work - Orders can not be undone - When testing, no Orders are made routing, failover_busy, failover_unreachable and failover_noanswer can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function sys System Options: hangup = Hangup the Call busy = Busy tone noservice = System Recording: Number not in service disconnected = System Recording: Number has been disconnected dtmf = DTMF Test echo = Sound Quality Test none Used to route calls to no action Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101' 'none:' 'sys:echo'"
},
"orderDIDInternationalTollFree": {
"location_id": "ID for a specific International Location (Values from getDIDsInternationalTollFree) (required)",
"quantity": "Number of dids to be purchased (Example: 2) (required)",
"routing": "Main Routing for the DID (required)",
"failover_busy": "Busy Routing for the DID",
"failover_unreachable": "Unreachable Routing for the DID",
"failover_noanswer": "NoAnswer Routing for the DID",
"voicemail": "Voicemail for the DID (Example: 101)",
"pop": "Point of Presence for the DID (Example: 5) (required)",
"dialtime": "Dial Time Out for the DID (Example: 60 -> in seconds) (required)",
"cnam": "CNAM for the DID (Boolean: 1/0) (required)",
"callerid_prefix": "Caller ID Prefix for the DID",
"note": "Note for the DID",
"account": "Reseller Sub Account (Example: '100001_VoIP')",
"monthly": "Montly Fee for Reseller Client (Example: 3.50)",
"setup": "Setup Fee for Reseller Client (Example: 1.99)",
"minute": "Minute Rate for Reseller Client (Example: 0.03)",
"test": "Set to true if testing how Orders work - Orders can not be undone - When testing, no Orders are made routing, failover_busy, failover_unreachable and failover_noanswer can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function sys System Options: hangup = Hangup the Call busy = Busy tone noservice = System Recording: Number not in service disconnected = System Recording: Number has been disconnected dtmf = DTMF Test echo = Sound Quality Test none Used to route calls to no action Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101' 'none:' 'sys:echo'"
},
"orderDIDVirtual": {
"digits": "Three Digits for the new Virtual DID (Example: 001) (required)",
"routing": "Main Routing for the DID (required)",
"failover_busy": "Busy Routing for the DID",
"failover_unreachable": "Unreachable Routing for the DID",
"failover_noanswer": "NoAnswer Routing for the DID",
"voicemail": "Voicemail for the DID (Example: 101)",
"pop": "Point of Presence for the DID (Example: 5) (required)",
"dialtime": "Dial Time Out for the DID (Example: 60 -> in seconds) (required)",
"cnam": "CNAM for the DID (Boolean: 1/0) (required)",
"callerid_prefix": "Caller ID Prefix for the DID",
"note": "Note for the DID",
"account": "Reseller Sub Account (Example: '100001_VoIP')",
"monthly": "Montly Fee for Reseller Client (Example: 3.50)",
"setup": "Setup Fee for Reseller Client (Example: 1.99)",
"minute": "Minute Rate for Reseller Client (Example: 0.03)",
"test": "Set to true if testing how Orders work - Orders can not be undone - When testing, no Orders are made routing, failover_busy, failover_unreachable and failover_noanswer can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function sys System Options: hangup = Hangup the Call busy = Busy tone noservice = System Recording: Number not in service disconnected = System Recording: Number has been disconnected dtmf = DTMF Test echo = Sound Quality Test none Used to route calls to no action Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101' 'none:' 'sys:echo'"
},
"orderTollFree": {
"did": "DID to be Ordered (Example: 8772223333) (required)",
"routing": "Main Routing for the DID (required)",
"failover_busy": "Busy Routing for the DID",
"failover_unreachable": "Unreachable Routing for the DID",
"failover_noanswer": "NoAnswer Routing for the DID",
"voicemail": "Voicemail for the DID (Example: 101)",
"pop": "Point of Presence for the DID (Example: 5) (required)",
"dialtime": "Dial Time Out for the DID (Example: 60 -> in seconds) (required)",
"cnam": "CNAM for the DID (Boolean: 1/0) (required)",
"callerid_prefix": "Caller ID Prefix for the DID",
"note": "Note for the DID",
"account": "Reseller Sub Account (Example: '100001_VoIP')",
"monthly": "Montly Fee for Reseller Client (Example: 3.50)",
"setup": "Setup Fee for Reseller Client (Example: 1.99)",
"minute": "Minute Rate for Reseller Client (Example: 0.03)",
"test": "Set to true if testing how Orders work - Orders can not be undone - When testing, no Orders are made routing, failover_busy, failover_unreachable and failover_noanswer can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function sys System Options: hangup = Hangup the Call busy = Busy tone noservice = System Recording: Number not in service disconnected = System Recording: Number has been disconnected dtmf = DTMF Test echo = Sound Quality Test none Used to route calls to no action Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101' 'none:' 'sys:echo'"
},
"orderVanity": {
"did": "DID to be Ordered (Example: 8772223333) (required)",
"routing": "Main Routing for the DID (required)",
"failover_busy": "Busy Routing for the DID",
"failover_unreachable": "Unreachable Routing for the DID",
"failover_noanswer": "NoAnswer Routing for the DID",
"voicemail": "Voicemail for the DID (Example: 101)",
"pop": "Point of Presence for the DID (Example: 5) (required)",
"dialtime": "Dial Time Out for the DID (Example: 60 -> in seconds) (required)",
"cnam": "CNAM for the DID (Boolean: 1/0) (required)",
"callerid_prefix": "Caller ID Prefix for the DID",
"note": "Note for the DID",
"carrier": "Carrier for the DID (Values from getCarriers) (required)",
"account": "Reseller Sub Account (Example: '100001_VoIP')",
"monthly": "Montly Fee for Reseller Client (Example: 3.50)",
"setup": "Setup Fee for Reseller Client (Example: 1.99)",
"minute": "Minute Rate for Reseller Client (Example: 0.03)",
"test": "Set to true if testing how Orders work - Orders can not be undone - When testing, no Orders are made routing, failover_busy, failover_unreachable and failover_noanswer can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function sys System Options: hangup = Hangup the Call busy = Busy tone noservice = System Recording: Number not in service disconnected = System Recording: Number has been disconnected dtmf = DTMF Test echo = Sound Quality Test none Used to route calls to no action Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101' 'none:' 'sys:echo'"
},
"removeDIDvPRI": {
"vpri": "Id for specific Vpri",
"did": "DID Number to be remove from our Vpri (Example: 561115) (required)"
},
"searchDIDsCAN": {
"province": "Canadian Province (Values from getProvinces)",
"type": "Type of search (Values: 'starts', 'contains', 'ends') (required)",
"query": "Query for searching (Examples: 'JOHN', '555', '123ABC') (required)"
},
"searchDIDsUSA": {
"state": "United States State (Values from getStates)",
"type": "Type of search (Values: 'starts', 'contains', 'ends') (required)",
"query": "Query for searching (Examples: 'JOHN', '555', '123ABC') (required)"
},
"searchTollFreeCanUS": {
"type": "Type of search (Values: 'starts', 'contains', 'ends')",
"query": "Query for searching (Examples: 'JOHN', '555', '123ABC')"
},
"searchTollFreeUSA": {
"type": "Type of search (Values: 'starts', 'contains', 'ends')",
"query": "Query for searching (Examples: 'JOHN', '555', '123ABC')"
},
"searchVanity": {
"type": "Type of Vanity Number Values: '8**', '800', '833', '844', '855', '866', '877', '888' (required)",
"query": "Query for searching : 7 Chars Examples: '***JHON', '**555**', '**HELLO' (required)"
},
"sendSMS": {
"did": "DID Numbers which is sending the message (Example: 5551234567) (required)",
"dst": "Destination Number (Example: 5551234568) (required)",
"message": "Message to be sent (Example: 'hello John Smith' max chars: 160) (required)"
},
"sendMMS": {
"did": "DID Numbers which is sending the message (Example: 5551234567) (required)",
"dst": "Destination Number (Example: 5551234568) (required)",
"message": "Message to be sent (Example: 'hello John Smith' max chars: 2048) (required)",
"media1": "Url to media file (Example: 'https://voip.ms/themes/voipms/assets/img/talent.jpg?v=2' (optional)",
"media2": "Base 64 image encode (Example: data:image/png;base64,iVBORw0KGgoAAAANSUh...) (optional)",
"media3": "Empty value (Example: '' ) (optional)"
},
"setCallback": {
"callback": "ID for a specific Callback (Example: 2359 / Leave empty to create a new one)",
"description": "Description for the Callback (required)",
"number": "Number that will be called back (required)",
"delay_before": "Delay befor calling back (required)",
"response_timeout": "Time before hanging up for incomplete input (required)",
"digit_timeout": "Time between digits input (required)",
"callerid_number": "Caller ID Override for the callback"
},
"setCallerIDFiltering": {
"filter": "ID for a specific Caller ID Filtering (Example: 18915 / Leave empty to create a new one)",
"callerid": "Caller ID that triggers the Filter (i = Not North American format, 0 = Anonymous, NPANXXXXXX, s or sb or sc = STIR/SHAKEN Attestation Level, p = All Phone Book, p:XXXX = Specific Phone Book Group) (required)",
"did": "DIDs affected by the filter (all, NPANXXXXXX) (required)",
"routing": "Route the call follows when filter is triggered (required)",
"failover_unreachable": "Route the call follows when unreachable",
"failover_busy": "Route the call follows when busy",
"failover_noanswer": "Route the call follows when noanswer",
"note": "Note for the Caller ID Filtering"
},
"setCallHunting": {
"callhunting": "ID for a specific Call Hunting (Example: 235 / Leave empty to create a new one)",
"description": "Description for the Call Hunting (required)",
"music": "Music on Hold Code (Values from getMusicOnHold) (required)",
"recording": "Recording for the Call Hunting (values from getRecordings) (required)",
"language": "Language for the Call Hunting (values from getLanguages) (required)",
"order": "The members will be called in follow or random order (values follow or random) (required)",
"members": "The list of members assigned to the call hunting (required)",
"ring_time": "The Maximum amount of time the call will ring the member (required)",
"press": "This option confirm if the member will take the call by pressing 1 * ring_time and press parameters need to have the same amount of items as the members parameter, one for each member. (required)"
},
"setDIDBillingType": {
"did": "DID affected by the new billing plan (required)",
"billing_type": "Billing type for the DID (1 = Per Minute, 2 = Flat) (required)"
},
"setDIDInfo": {
"did": "DID to be Updated (Example: 5551234567) (required)",
"routing": "Main Routing for the DID (required)",
"failover_busy": "Busy Routing for the DID",
"failover_unreachable": "Unreachable Routing for the DID",
"failover_noanswer": "NoAnswer Routing for the DID",
"voicemail": "Voicemail for the DID",
"pop": "Point of Presence for the DID (\"server_pop\" values from getServersInfo. Example: 3) (required)",
"dialtime": "Dial Time Out for the DID (Example: 60 -> in seconds) (required)",
"cnam": "CNAM for the DID (Boolean: 1/0) (required)",
"callerid_prefix": "Caller ID Prefix for the DID",
"record_calls": "Record Calls (Boolean: 1/0)",
"inbound_dialing_mode": "Dialing Mode for Inbound Calls (Boolean: 0 = NANPA , 1 = E164)",
"note": "Note for the DID",
"port_out_pin": "Port Out PIN protection is used as a means of authorizing outgoing portability (only for selected US numbers with the lock icon)",
"billing_type": "Billing type for the DID (1 = Per Minute, 2 = Flat) (required)",
"transcribe": "Enable Call Transcription (Boolean: 1/0)",
"transcription_locale": "Transcription locale code (values from getLocales, comma separated for more than one locale up to 10 locales)",
"transcription_redaction": "Transcription redaction (Values: 'yes'/'no')",
"transcription_summary": "Transcription summary (Values: 'yes'/'no')",
"transcription_sentiment": "Transcription sentiment (Values: 'yes'/'no')",
"transcription_email": "Call Transcription Email",
"sms_sipaccount_enabled": "If Enable, SMS Messages received by your DID will be sent to the specified SIP account or sub-account (Values: 1=Enable / 0=Disable)",
"sms_sipaccount": "SIP account or sub-account that will receive the SMS Messages",
"transcription_start_delay": "Call Transcription Delay Seconds between 0 and 60, Increments of 5 (Example: 10 -> seconds)",
"voicemail_threshold": "Voicemail Threshold Seconds between 0 and 60, Increments of 5 (Example: 10 -> seconds) routing, failover_busy, failover_unreachable and failover_noanswer can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function sys System Options: hangup = Hangup the Call busy = Busy tone noservice = System Recording: Number not in service disconnected = System Recording: Number has been disconnected dtmf = DTMF Test echo = Sound Quality Test none Used to route calls to no action Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101' 'none:' 'sys:echo'"
},
"setDIDPOP": {
"did": "DID to be Updated (Example: 5551234567) (required)",
"pop": "Point of Presence for the DID (\"server_pop\" values from getServersInfo. Example: 3) (required)"
},
"setDIDRouting": {
"did": "DID to be Updated (Example: 5551234567) (required)",
"routing": "Main Routing for the DID routing can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101' (required)"
},
"setDIDVoicemail": {
"did": "DID to be Updated (Example: 5551234567) (required)",
"voicemail": "Mailbox for the DID"
},
"setDISA": {
"disa": "ID for a specific DISA (Example: 2114 / Leave empty to create a new one)",
"name": "Name for the DISA (required)",
"pin": "Password for the DISA (required)",
"digit_timeout": "Time between digits (required)",
"callerid_override": "Caller ID Override for the DISA",
"language": "Language for the DISA (en, fr, es)"
},
"setForwarding": {
"forwarding": "ID for a specific Forwarding (Example: 19183 / Leave empty to create a new one)",
"phone_number": "Phone Number for the Forwarding (required)",
"callerid_override": "Caller ID Override for the Forwarding",
"description": "Description for the Forwarding",
"dtmf_digits": "Send DTMF digits when call is answered",
"pause": "Pause (seconds) when call is answered before sending digits (Example: 1.5 / Values: 0 to 10 in increments of 0.5)",
"diversion_header": "If enabled, we will add a Diversion Header to your forwarded call",
"attestation_a_enabled": "If enabled, Forwarded calls will be sent with Attestation A"
},
"setIVR": {
"ivr": "ID for a specific IVR (Example: 4636 / Leave empty to create a new one)",
"name": "Name for the IVR (required)",
"recording": "Recording for the IVR (values from getRecordings) (required)",
"timeout": "Maximum time for type in a choice after recording (required)",
"language": "Language for the IVR (values from getLanguages) (required)",
"voicemailsetup": "Voicemail Setup for the IVR (values from getVoicemailSetups) (required)",
"choices": "Choices for the IVR (Example: '1=sip:5096 ; 2=fwd:20222') (required)"
},
"setPhonebook": {
"phonebook": "ID for a specific Phonebook entry (Example: 32207 / Leave empty to create a new one)",
"speed_dial": "Speed Dial for the Phonebook entry",
"name": "Name for the Phonebook Entry (required)",
"number": "Number or SIP for the Phonebook entry (Example: 'sip:2563' or '5552223333') (required)",
"callerid": "Caller ID Override when dialing via Speed Dial",
"note": "Note for the phonebook entry",
"group": "ID for a specific Phonebook group"
},
"setPhonebookGroup": {
"group": "ID for a specific Phonebook group (Example: 32207 / Leave empty to create a new one)",
"name": "Name for the Phonebook group (required)",
"members": "Phonebook entry codes associated to this group separated by a semicolon"
},
"setRecording": {
"recording": "ID for a specific Phonebook entry (Example: 33221 / Leave empty to create a new one)",
"file": "Base64 encoded file (Provide Recording ID and file if you want update the file only) (required)",
"name": "Name for the Recording Entry (Example: 'recording1') (Provide Recording ID and name if you want update the name only) (Provide Recording ID, file and name if you want update both parameters at the same time) (required)"
},
"setQueue": {
"queue": "ID for a specific Queue entry (Example: 32208 / Leave empty to create a new one)",
"queue_name": "Queue entry name (required)",
"queue_number": "Queue entry number (required)",
"queue_language": "Language Code (Values from getLanguages) (required)",
"queue_password": "Queue Password",
"callerid_prefix": "Caller ID Prefix for queue",
"join_announcement": "Recording Code (Values from getRecordings or 'none')",
"priority_weight": "weight/priority of queue (Values 1 to 60) (required)",
"agent_announcement": "Recording Code (Values from getRecordings or 'none')",
"report_hold_time_agent": "Report hold time to agent (Values from getReportEstimatedHoldTime) (required)",
"member_delay": "Member delay when the agent is connected to the caller (Values 1 to 15 in seconds or 'none')",
"maximum_wait_time": "Ammount of time a caller can wait in queue (Values in seconds: multiples of 30, max value: 1200 or 'unlimited')",
"maximum_callers": "Maximum callers (Values: 1 to 60 or 'unlimited')",
"join_when_empty": "How caller join to the queue (Values from getJoinWhenEmptyTypes) Examples: yes Callers can join a queue with no members or only unavailable members no Callers cannot join a queue with no members strict Callers cannot join a queue with no members or only unavailable members (required)",
"leave_when_empty": "How caller leave the queue (Values 'yes'/'no'/'strict') Examples: yes Callers are sent to failover when there are no members no Callers will remain in the queue even if there are no members strict Callers are sent to failover if there are members but none of them is available. (required)",
"ring_strategy": "Ring strategy (Values from getRingStrategies) (required)",
"ring_inuse": "If you want the queue to avoid sending calls to members (Values 'yes'/'no') (required)",
"agent_ring_timeout": "Number of seconds to ring an agent (Values 5 to 60)",
"retry_timer": "How long do we wait before trying all the members again (Values 5 to 60 seconds or 'none'= No Delay)",
"wrapup_time": "After a successful call, the number of seconds to wait before sending a free agent another call (Values 1 to 60 seconds or 'none'= No Delay)",
"voice_announcement": "Code for Recording (Values from getRecordings or 'none')",
"frequency_announcement": "Periodic interval to play voice announce recording (Values in seconds: multiples of 15, max value: 1200 or 'none' = No announcement)",
"announce_position_frecuency": "How often to make any periodic announcement (Values in seconds: multiples of 15, max value: 1200 or 'none' = No announcement)",
"announce_round_seconds": "Announce seconds (Values in seconds: 1 to 60 or 'none' = Do not announce)",
"if_announce_position_enabled_report_estimated_hold_time": "Include estimated hold time in position announcements (Values 'yes'/'no'/'once')",
"thankyou_for_your_patience": "Yes to say \"Thank you for your patience\" immediatly after announcing Queue Position and Estimated hold time left (Values 'yes'/'no')",
"music_on_hold": "Music on Hold Code (Values from getMusicOnHold)",
"fail_over_routing_timeout": "Failover routing to Maximum wait time reached",
"fail_over_routing_full": "Failover routing to Maximum callers reached",
"fail_over_routing_join_empty": "A call was sent to the queue but the queue had no members (Only works when Join when Empty is set to no)",
"fail_over_routing_leave_empty": "The last agent was removed form the queue before alls calls were handled (Only works when Leave when Empty is set to yes)",
"fail_over_routing_join_unavail": "Same as routingjoinempty, except that there were still queue members, but all were status unavailable",
"fail_over_routing_leave_unavail": "Same as routingleaveempty, except that there were still queue members, but all were status unavailable routings can receive values in the following format => header:record_id Where header could be: account, fwd, vm, sip, grp, ivr, sys, recording, queue, cb, tc, disa, none. Examples: account Used for routing calls to Sub Accounts You can get all sub accounts using the getSubAccounts function fwd Used for routing calls to Forwarding entries. You can get the ID right after creating a Forwarding with setForwarding or by requesting all forwardings entries with getForwardings. vm Used for routing calls to a Voicemail. You can get all voicemails and their IDs using the getVoicemails function Examples: 'account:100001_VoIP' 'fwd:1026' 'vm:101'"
},
"setRingGroup": {
"ring_group": "ID for a specific Ring Group (Example: 4768 / Leave empty to create a new one)",
"name": "Name for the Ring Group (required)",
"members": "Members for the Ring Group (Example: 'account:100001;fwd:16006') (required)",
"voicemail": "Voicemail for the Ring Group (Values from getVoicemails) (required)",
"caller_announcement": "Recording Code (Values from getRecordings)",
"music_on_hold": "Music on Hold Code (Values from getMusicOnHold)",
"language": "Code for Language (Values from getLanguages) \"members\" can receive the following routing headers: account Used to route the call to an Account or a Sub Account fwd Used to route the call to a Forwarding entry sip Used to route the call to a SIP URI Each member can a specific ring time and press1 values, you can add those to the routing header as follow: Example: 'account:100001,25,0;fwd:16006,10,1' 25 = Default ring time value (Values from 1 to 60 sec) 0 = Default press1 value (Values allowed 0 and 1)"
},
"setSIPURI": {
"sipuri": "ID for a specific SIP URI (Example: 6199 / Leave empty to create a new one)",
"uri": "SIP URI (Example: '[email protected]') (required)",
"description": "Description for the SIP URI",
"callerid_override": "This setting is optional. You can configure a 'CallerID Number Override'. Your default CallerID number will be changed to the override you have configured here when using this SIP URI.",
"callerid_e164": "If this option is Enabled, then your CallerID will be E164 compliant."
},
"setSMS": {
"did": "DID to be Updated (Example: 5551234567) (required)",
"enable": "Enable/Disable the DID to receive SMS Messages (Values: 1=Enable / 0=Disable) (required)",
"email_enabled": "If Enable, SMS Messages received by your DID will be sent to the email address provided (Values: 1=Enable / 0=Disable)",
"email_address": "SMS Messages received by your DID will be sent to the email address provided",
"sms_forward_enable": "If Enable, SMS Messages received by your DID will be forwarded to the phone number provided (Values: 1=Enable / 0=Disable)",
"sms_forward": "SMS Messages received by your DID will be forwarded to the phone number provided (Example: 5551234567)",
"url_callback_enable": "If Enable, SMS Messages received by your DID will be send a GET request to the URL callback provided (Values: 1=Enable / 0=Disable)",
"url_callback": "SMS Messages received by your DID will be send a GET request to the URL callback provided Available Variables for your URL {FROM} The phone number that sent you the message. {TO} The DID number that received the message. {MESSAGE} The content of the message. Example: http://mysite.com/sms.php?to={TO}&from={FROM}&message={MESSAGE}",
"url_callback_retry": "Enable URL callback Retry (Values: 1=Enable / 0=Disable) we will be expecting an 'ok' output (without quotes) from your URL callback page as an indicator that you have received the message correctly. If we don't receive the 'ok' letters (wihtout quotes) from your callback page, we will keep sending you the same message every 30 minutes.",
"webhook_enable": "Enable/Disable URL Webhook (Values: 1=Enable / 0=Disable)",
"webhook": "SMS/MMS Webhook URL SMS/MMS Messages received by your DID will send a POST request to your 3CX or PortSIP PBX using the Webhook URL provided.",
"dialmode": "Dialing Mode for SMS (API) (Values: 1=NANPA / 2=E164) NANPA: Your messages will be sent using only 10 digits (without the +1 prefix). E164: Your messages will be sent using Country Code first (with the +1 prefix)",
"smpp_enabled": "If Enable, SMS Messages received by your DID will be sent to the specified SMPP URL (Values: 1=Enable / 0=Disable)",
"smpp_url": "SMS Messages received by your DID will be sent to the specified SMPP URL using the submit_sm command. The URL needs to specify if we should send the message encrypted or not using smpp (not encrypted) or ssmpp (encrypted). You can also specify the username, password, and the port in the URL.",
"smpp_user": "The SMPP Username that will be used to authenticate you. Outgoing messages should be sent to smpp.voip.ms through the regular 2775 port or the encrypted 3550 port. These messages can be sent using either deliver_sm or submit_sm commands.",
"smpp_pass": "The SMPP Password that will be used to authenticate you. Outgoing messages should be sent to smpp.voip.ms through the regular 2775 port or the encrypted 3550 port. These messages can be sent using either deliver_sm or submit_sm commands.",
"sms_sipaccount_enabled": "If Enable, SMS Messages received by your DID will be sent to the specified SIP account or sub-account (Values: 1=Enable / 0=Disable)",
"sms_sipaccount": "SIP account or sub-account that will receive the SMS Messages"
},
"setStaticMember": {
"member": "ID for a specific Member (Example: 619 / Leave empty to create a new one)",
"queue": "ID for a specific Queue (required)",
"member_name": "Member Description (required)",
"account": "Static Member Routing to receive calls - You can get all sub accounts using the getSubAccounts function",
"priority": "Values for get calls first (Example: 0) (required)"
},
"setTimeCondition": {
"timecondition": "ID for a specific Time Condition (Example: 1830 / Leave empty to create a new one)",
"name": "Name for the Time Condition (required)",
"routing_match": "Routing for the Call when condition matches (required)",
"routing_nomatch": "Routing for the Call when condition does not matche (required)",
"starthour": "All the Start Hour Conditions (Example: '8;8') (required)",
"startminute": "All the Start Minute Conditions (Example: '0;0') (required)",
"endhour": "All the End Hour Conditions (Example: '16;12') (required)",
"endminute": "All the End Minute Conditions (Example: '0;0') (required)",
"weekdaystart": "All the Week Day Start Conditions (Example: 'mon;sat') (required)",
"weekdayend": "All the Week Day End Conditions (Example: 'fri;sat') (required)"
},
"unconnectDID": {
"did": "DID to be Unconnected from Reseller Sub Account(Example: 5551234567) (required)"
},
"connectFAX": {
"did": "FAX DID to be Connected to Reseller Sub Account (Example: 5551234567) (required)",
"account": "Reseller Sub Account (Example: '100001_VoIP') (required)",
"monthly": "Montly Fee for Reseller Client (Example: 3.50) (required)",
"setup": "Setup Fee for Reseller Client (Example: 1.99) (required)",
"minute": "Minute Rate for Reseller Client (Example: 0.03) (required)",
"next_billing": "Next billing date (Example: '2014-03-30')",
"dont_charge_setup": "If set to true, the setup value will not be charged after Connect",
"dont_charge_monthly": "If set to true, the monthly value will not be charged after Connect"
},
"unconnectFAX": {
"did": "FAX DID to be Unconnected from Reseller Sub Account (Example: 5551234567) (required)"
},
"cancelFaxNumber": {
"id": "ID for a specific Fax Number (Example: 923) (required)",
"test": "Set to true if testing how cancel a Fax Number"
},
"deleteFaxMessage": {
"id": "ID for a specific Fax Message (Example: 923) (required)",
"test": "Set to true if testing how cancel a Fax Message"
},
"delEmailToFax": {
"id": "ID for a specific \"Email To Fax Configuration\" (Example: 923) (required)",
"test": "Set to true if testing how cancel a \"Email To Fax Configuration\""
},
"delFaxFolder": {
"id": "ID for a specific Fax Folder (Example: 923) (required)",
"test": "Set to true if testing how to delete a Fax Folder"
},
"getBackOrders": {
"id": "ID for a specific backorder DID"
},
"getFaxProvinces": {
"province": "CODE for a specific Province (Example: AB)"
},
"getFaxStates": {
"state": "CODE for a specific State (Example: AL)"
},
"getFaxRateCentersCAN": {
"province": "Province two letters code (Example: AB) (required)"
},
"getFaxRateCentersUSA": {
"state": "Province two letters code (Example: AL) (required)"
},
"getFaxNumbersInfo": {
"did": "Fax Number to retrieves the information of a single number, or not send if you want retrieves the information of all your Fax Numbers."
},
"getFaxNumbersPortability": {
"did": "DID Number to be ported into our network (Example: 5552341234) (required)"
},
"getFaxMessages": {
"from": "Start Date for Filtering Fax Messages (Example: '2014-03-30') - Default value: Today",
"to": "End Date for Filtering Fax Messages (Example: '2014-03-30') - Default value: Today",
"folder": "Name of specific Fax Folder (Example: SENT) - Default value: ALL",
"id": "ID for a Specific Fax Message (Example: 23434)"
},
"getFaxMessagePDF": {
"id": "ID of the Fax Message requested (Values from getFaxMessages) (required)"
},
"mailFaxMessagePDF": {
"id": "ID of the Fax Message requested (Values from getFaxMessages) (required)",
"email": "Destination email adreess (example: [email protected]) (required)"
},
"moveFaxMessage": {
"fax_id": "ID of the Fax Message requested (Values from getFaxMessages) (required)",
"folder_id": "ID of the destination Fax Folder (Values from getFaxFolders) (required)",
"test": "Set to true if testing how to move a Fax Message"
},
"orderFaxNumber": {
"location": "Location ID of the Fax Number (Values from getFaxRateCentersCAN/getFaxRateCentersUSA) (required)",
"quantity": "Quantity of Fax Numbers to order (Example: 3) (required)",
"email": "Email address where send notifications when receive Fax Messages - (Example: [email protected])",
"email_enable": "Flag to enable the email notifications. - (Values: 1 = true, 0 = false) - Default: 0",
"email_attach_file": "Flag to enable attach the Fax Message as a PDF file in the notifications. - (Values: 1 = true, 0 = false) - Default: 0",
"url_callback": "URL where make a POST when you receive a Fax Message.",
"url_callback_enable": "Flag to enable the URL Callback functionality. - (Values: 1 = true, 0 = false) - Default: 0",
"url_callback_retry": "Flag to enable retry the POST action in case we don't receive \"ok\".",
"test": "Set to true if testing how Orders work - Orders can not be undone - When testing, no Orders are made"
},
"setFaxFolder": {
"name": "Name of the Fax Folder to create or update (Example: FAMILY) (required)",
"id": "[Only for updates] ID of the Fax Folder to edit (Values from getFaxFolders)",
"test": "Set to true if testing how to create/update a Fax Folder"
},
"setEmailToFax": {
"id": "[Only for updates] ID of the \"Email to Fax\" to edit (Values from getEmailToFax)",
"enabled": "If Enable, we will send Fax Message when we receive an email from the provided address. (Values: 1=Enable / 0=Disable)",
"auth_email": "Email address from you will sent Fax Messages (required)",
"from_number_id": "Fax number that will appear as fax sender. (values from getFaxNumbersInfo) (required)",
"security_code_enabled": "If Enable, we will check the mail subject if this include a Security Code before send the Fax. (Values: 1=Enable / 0=Disable)",
"security_code": "An alphanumeric code to identify your emails before send as Fax. (required)",
"test": "Set to true if testing."
},
"searchFaxAreaCodeCAN": {
"area_code": "Area code number, as the initial of the Fax Number you looking for. (values from getFaxRateCentersCAN) (required)"
},
"searchFaxAreaCodeUSA": {
"area_code": "Area code number, as the initial of the Fax Number you looking for. (values from getFaxRateCentersUSA) (required)"
},
"setFaxNumberInfo": {
"did": "DID Number to be ported into our network (Example: 5552341234) (required)",
"email": "Email address where send notifications when receive Fax Messages - (Example: [email protected])",
"email_enable": "Flag to enable the email notifications. - (Values: 1 = true, 0 = false) - Default: 0",
"email_attach_file": "Flag to enable attach the Fax Message as a PDF file in the notifications. - (Values: 1 = true, 0 = false) - Default: 0",
"url_callback": "URL where make a POST when you receive a Fax Message.",
"url_callback_enable": "Flag to enable the URL Callback functionality. - (Values: 1 = true, 0 = false) - Default: 0",
"url_callback_retry": "Flag to enable retry the POST action in case we don't receive \"ok\".",
"fax_to_sip_enabled": "Flag to enable Fax to SIP. - (Values: 1 = true, 0 = false) - Default: 0",
"fax_to_sip_enabled_account": "Fax to SIP subaccount to use (Values from getSubaccounts) Eg: ######_SubAccount.",
"note": "Description you wish to indicate for this DID (for your own use, but not mandatory).",
"test": "Set to true if testing how to update the information of a Fax Number"
},
"setFaxNumberEmail": {
"did": "DID Number to be ported into our network (Example: 5552341234) (required)",
"email": "Email address where send notifications when receive Fax Messages - (Example: [email protected])",
"email_enable": "Flag to enable the email notifications. - (Values: 1 = true, 0 = false) - Default: 0",
"email_attach_file": "Flag to enable attach the Fax Message as a PDF file in the notifications. - (Values: 1 = true, 0 = false) - Default: 0",
"test": "Set to true if testing how to set the email of a Fax Number"
},
"setFaxNumberURLCallback": {
"did": "DID Number to be ported into our network (Example: 5552341234) (required)",
"url_callback": "URL where make a POST when you receive a Fax Message.",
"url_callback_enable": "Flag to enable the URL Callback functionality. - (Values: 1 = true, 0 = false) - Default: 0",
"url_callback_retry": "Flag to enable retry the POST action in case we don't receive \"ok\".",
"test": "Set to true if testing how to set the URL callback of a Fax Number"
},
"sendFaxMessage": {
"to_number": "Destination DID Number (Example: 5552341234) (required)",
"from_name": "Name of the sender (Example: 5552341234) (required)",
"from_number": "DID number of the Fax sender (required)",
"send_email_enabled": "Flag to enable the send of a copy of your Fax via email. - (Values: 1 = true, 0 = false) - Default: 0",
"send_email": "Email address where you want send a copy of your Fax.",
"station_id": "An word to identify a equipment or department sending the Fax.",
"file": "The file must be encoded in Base64, and in one of the following formats: pdf, txt, jpg, gif, png, tif (required)",
"test": "Set to true if testing how to send a Fax Message"
},
"e911AddressTypes": {
"type": "Code for a specific Address Type (Example: Apartment)"
},
"e911Cancel": {
"did": "DID to be canceled. (required)"
},
"e911Info": {
"did": "DID with e911 enabled / in process. (required)"
},
"e911Provision": {
"did": "DID that will be sent to the e911 service. (required)",
"full_name": "Full Name that will be sent to the e911 service. (required)",
"street_number": "Street Number that will be sent to the e911 service. (required)",
"street_name": "Street Name that will be sent to the e911 service. (required)",
"address_type": "Address Type that will be sent to the e911 service (Values from e911AddressTypes).",
"address_number": "Address Number that will be sent to the e911 service.",
"city": "City that will be sent to the e911 service. (required)",
"state": "State / Province that will be sent to the e911 service. (required)",
"country": "Country that will be sent to the e911 service. Value can be US (United states) or CA (Canada). (required)",
"zip_code": "Zip / Postal code that will be sent to the e911 service. (required)",
"language": "Language that will be sent to the e911 service. Only available for addresses from Canada. Value can be EN (English) or FR (French). (required)",
"email": "Email that will be sent to the e911 service. (required)",
"other_info": "Additional Address Information that will be sent to the e911 service. Only available for addresses from Canada."
},
"e911ProvisionManually": {
"did": "DID that will be sent to the e911 service. (required)",
"full_name": "Full Name that will be sent to the e911 service. (required)",
"street_number": "Street Number that will be sent to the e911 service. (required)",
"street_name": "Street Name that will be sent to the e911 service. (required)",
"address_type": "Address Type that will be sent to the e911 service (Values from e911AddressTypes).",
"address_number": "Address Number that will be sent to the e911 service.",
"city": "City that will be sent to the e911 service. (required)",
"state": "State / Province that will be sent to the e911 service. (required)",
"country": "Country that will be sent to the e911 service. Value can be US (United states) or CA (Canada). (required)",
"zip_code": "Zip / Postal code that will be sent to the e911 service. (required)",
"language": "Language that will be sent to the e911 service. Only available for addresses from Canada. Value can be EN (English) or FR (French). (required)",
"email": "Email that will be sent to the e911 service. (required)",
"other_info": "Additional Address Information that will be sent to the e911 service. Only available for addresses from Canada."
},
"e911Update": {
"did": "DID with e911 enabled / in process. (required)",
"full_name": "Full Name that will be updated to the e911 service. (required)",
"street_number": "Street Number that will be updated to the e911 service. (required)",
"street_name": "Street Name that will be updated to the e911 service. (required)",
"address_type": "Address Type that will be updated to the e911 service (Values from e911AddressTypes).",
"address_number": "Address Number that will be updated to the e911 service.",
"city": "City that will be updated to the e911 service. (required)",
"state": "State / Province that will be updated to the e911 service. (required)",
"country": "Country that will be updated to the e911 service. Value can be US (United states) or CA (Canada). (required)",
"zip_code": "Zip / Postal code that will be updated to the e911 service. (required)",
"language": "Language that will be updated to the e911 service. Only available for addresses from Canada. Value can be EN (English) or FR (French). (required)",
"email": "Email that will be updated to the e911 service. (required)",
"other_info": "Additional Address Information that will be updated to the e911 service. Only available for addresses from Canada."
},
"e911Validate": {
"did": "DID with e911 enabled / in process. (required)",
"full_name": "Full Name that will be validated. (required)",
"street_number": "Street Number that will be validated. (required)",
"street_name": "Street Name that will be validated. (required)",
"address_type": "Address Type that will be validated (Values from e911AddressTypes).",
"address_number": "Address Number that will be validated.",
"city": "City that will be validated. (required)",
"state": "State / Province that will be validated. (required)",
"country": "Country that will be validated. Value can be US (United states) or CA (Canada). (required)",
"zip_code": "Zip / Postal code that will be validated. (required)",
"language": "Language that will be validated. Only available for addresses from Canada. Value can be EN (English) or FR (French).",
"email": "Email that will be validated. (required)",
"other_info": "Additional Address Information that will be validated. Only available for addresses from Canada."
},
"addLNPPort": {
"numbers": "DID(s) to port into VoIP.ms network (Example: 5552341234,5552341233). If you are porting more than one number, please separate them with commas. (required)",
"portType": "Digits from 1 to 4: 1: United States Local numbers 2: Canadian Local Numbers 3: US/CA Toll Free Numbers 4: United States Fax numbers 5: Canadian Fax Numbers (required)",
"isPartial": "If you have more then 1 number with your current carrier and not porting them all, choose yes. If you are porting all the numbers, choose no. Please note that you still need to include all numbers you want to port. If you have 2 numbers and want to port both, you need to include both numbers in the list of numbers to port. - (Values: 1 = true, 0 = false) - Default: 0",
"locationType": "- (Values: 1 = Business, 0 = Residential) - Default: 0",
"isMobile": "- (Values: 1 = All the numbers are mobile numbers, 0 = false) - Default: 0",
"pin": "PIN Number",
"imei": "[Required If portType = 2 or portType = 5] If you are porting your mobile number(s), please provide the IMEI*. To get the IMEI* of your phone, you can dial *#06#",
"btn": "[Required If isMobile = 1] BTN: It is the phone number to which all the other numbers of the customer are charged, in a consolidated telephone bill (instead of showing separate charges for each number you own). Please try to find the BTN on your invoice, and if you are unable to do so please contact the current provider to obtain it.",
"services": "[Required If isMobile = 1] Please be specific and describe ALL remaining services with the current carrier. This includes DSL/Data services, Hunt Group services, etc. Any services NOT listed below may be disconnected upon completion of this port order.",
"tfType": "[Required If portType = 3] Values: 1 - American Carrier, American Callers Only, 2 - American Carrier, American and Canadian Callers allowed, 3 - Canadian Carrier",
"statementName": "This is for Business numbers only. Please type your Company Name if applicable, otherwise leave it blank. (required)",
"firstName": "This is the \"Customer First Name\" as it appears on the CSR (Customer Service Record) of the losing carrier. Please Enter the first name of the owner of the number or the autorized contact. No company name must be entered in the field. (required)",
"lastName": "This is the \"Customer Last Name\" as it appears on the CSR (Customer Service Record) of the losing carrier. Please Enter the last name of the owner of the number or the autorized contact. No company name must be entered in the field (required)",
"address1": "This is the \"Customer Address\" as it appears on the CSR (Customer Service Record) of the losing carrier. (required)",
"address2": "Optional Address information (e.g: Suite 343)",
"city": "This is the \"City\" as it appears on the CSR (Customer Service Record) of the losing carrier. (required)",
"zip": "This is the \"ZIP or Postal Code\" as it appears on the CSR (Customer Service Record) of the losing carrier. (required)",
"state": "This is the \"State or Province\" as it appears on the CSR (Customer Service Record) of the losing carrier. (required)",
"country": "This is the \"Country\" as it appears on the CSR (Customer Service Record) of the losing carrier. (required)",
"providerName": "The name of your current service provider. (required)",
"providerAccount": "Your Account with your current service provider. (required)",
"notes": "- If you would like to include additional information regarding this port, you can use this parameter."
},
"addLNPFile": {
"portid": "ID of the port previously created. (required)",
"file": "Base 64 code of the file to be attached (required)"
},
"getLNPList": {
"portid": "ID of the port previously created. (required)",
"portStatus": "Status code to filtering Ports. Example: precessing. (You can use the values returned by the method getLNPListStatus)",
"startDate": "Start Date for filtering Ports. (Example: '2014-03-30')",
"endDate": "End Date for filtering Ports. (Example: '2014-03-30')"
},
"getLNPStatus": {
"portid": "ID of the port previously created. (required)"
},
"getLNPDetails": {
"portid": "ID of the port previously created. (required)"
},
"getLNPNotes": {
"portid": "ID of the port previously created. (required)"
},
"getLNPAttach": {
"portid": "ID of the port previously created. (required)",
"attachid": "ID of the invoice (attachment) previously uploaded. (required)"
},
"getLNPAttachList": {
"portid": "ID of the port previously created. (required)"
},
"createVoicemail": {
"digits": "Digits used to create the voicemail (Example: 01) Minimum 1 digit, maximum 10 digits (required)",
"name": "Name for the Mailbox (required)",
"password": "Password for the Mailbox (required)",
"skip_password": "True if Skipping Password (Boolean: 1/0) (required)",
"email": "Email address for receiving messages, multiple email addresses are allowed if separated by a comma",
"attach_message": "Yes for Attaching WAV files to Message (Values: 'yes'/'no') (required)",
"delete_message": "Yes for Deleting Messages (Values: 'yes'/'no') (required)",
"say_time": "Yes for Saying Time Stamp (Values: 'yes'/'no') (required)",
"timezone": "Time Zone for Mailbox (Values from getTimeZones) (required)",
"say_callerid": "Yes for Saying the Caller ID (Values: 'yes'/'no') (required)",
"play_instructions": "Code for Play Instructions Setting (Values from getPlayInstructions) (required)",
"language": "Code for Language (Values from getLanguages) (required)",
"client": "ID for a specific Reseller Client (Example: 561115) (optional)",
"transcription": "'yes' to enable Voicemail Transcription",
"transcription_locale": "Transcription locale code (values from getLocales, comma separated for more than one locale up to 10 locales)",
"transcription_redaction": "Yes for Transcription redaction (Values: 'yes'/'no')",
"transcription_summary": "Yes for Transcription summary (Values: 'yes'/'no')",
"transcription_sentiment": "Yes for Transcription sentiment (Values: 'yes'/'no')",
"transcription_format": "Transcription format ( Values: 'html'/'text')",
"transcription_delay": "Delay in seconds before voicemail transcription starts. Use 0 for none, or 5 through 60 in steps of 5. Omit this parameter to leave the current value unchanged.",
"email_attachment_format": "Code for Email Attachment format (Values from getVoicemailAttachmentFormats)",
"unavailable_message_recording": "Recording for the Unavailable Message (values from getRecordings)"
},
"delMessages": {
"mailbox": "ID for a specific Mailbox (Example: 1001) (required)",
"folder": "Name for specific Folder (Required if message id is passed, Example: 'INBOX', values from: getVoicemailFolders)",
"message_num": "ID for specific Voicemail Message (Required if folder is passed, Example: 1)"
},
"delMemberFromConference": {
"member": "ID for a specific Member (Example: 101) (required)",
"conference": "ID for a specific Conference (Example: 3829)"
},
"delVoicemail": {
"mailbox": "ID for a specific Mailbox (Example: 1001) (required)"
},
"getPlayInstructions": {
"play_instructions": "Code for a specific Play Instructions setting (Example: 'u')"
},
"getTimezones": {
"timezone": "Code for a specific Time Zone (Example: 'America/Buenos_Aires')"
},
"getVoicemails": {
"mailbox": "ID for specific Mailbox (Example: 1001)",
"client": "ID for a specific Reseller Client (Example: 561115) (optional)"
},
"getVoicemailFolders": {
"folder": "Folder Name (Example: 'INBOX')",
"mailbox": "ID for specific Mailbox (Example: 1001)"
},
"getVoicemailMessageFile": {
"mailbox": "ID for specific Mailbox (Example: 1001) (required)",
"folder": "Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders) (required)",
"message_num": "ID for specific Voicemail Message (Example: 1) (required)",
"format": "File format. Default value is mp3. Values: mp3, wav, wav49, gsm."
},
"getVoicemailMessages": {
"mailbox": "ID for specific Mailbox (Example: 1001) (required)",
"folder": "Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders)",
"date_from": "Start Date for Filtering Voicemail Messages (Example: '2016-01-30')",
"date_to": "End Date for Filtering Voicemail Messages (Example: '2016-01-30')"
},
"getVPRIs": {
"vpri": "ID for specific vpri (Example: 1001) (required)"
},
"markListenedVoicemailMessage": {
"mailbox": "ID for specific Mailbox (Example: 1001) (required)",
"folder": "Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders) (required)",
"message_num": "ID for specific Voicemail Message (Example: 1) (required)",
"listened": "Code for mark voicemail as listened or not-listened (Values: 'yes'/'no') (required)"
},
"markUrgentVoicemailMessage": {
"mailbox": "ID for specific Mailbox (Example: 1001) (required)",
"folder": "Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders) (required)",
"message_num": "ID for specific Voicemail Message (Example: 1) (required)",
"urgent": "Code for mark voicemail as urgent or not-urgent (Values: 'yes'/'no') (required)"
},
"moveFolderVoicemailMessage": {
"mailbox": "ID for specific Mailbox (Example: 1001) (required)",
"folder": "Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders) (required)",
"message_num": "ID for specific Voicemail Message (Example: 1) (required)",
"new_folder": "Destination Folder (Example: 'Urgent', values from: getVoicemailFolders) (required)"
},
"sendVoicemailEmail": {
"mailbox": "ID for specific Mailbox (Example: 1001) (required)",
"folder": "Name for specific Folder (Example: 'INBOX', values from: getVoicemailFolders) (required)",
"message_num": "ID for specific Voicemail Message (Example: 1) (required)",
"email_address": "Destination Email address (Example: [email protected]) (required)"
},
"setVoicemail": {
"mailbox": "ID for a specific Mailbox (Example: 1001) (required)",
"name": "Name for the Mailbox (required)",
"password": "Password for the Mailbox (required)",
"skip_password": "True if Skipping Password (Boolean: 1/0) (required)",
"email": "Email address for receiving messages, multiple email addresses are allowed if separated by a comma",
"attach_message": "Yes for Attaching WAV files to Message (Values: 'yes'/'no') (required)",
"delete_message": "Yes for Deleting Messages (Values: 'yes'/'no') (required)",
"say_time": "Yes for Saying Time Stamp (Values: 'yes'/'no') (required)",
"timezone": "Time Zone for Mailbox (Values from getTimeZones) (required)",
"say_callerid": "Yes for Saying the Caller ID (Values: 'yes'/'no') (required)",
"play_instructions": "Code for Play Instructions Setting (Values from getPlayInstructions) (required)",
"language": "Code for Language (Values from getLanguages) (required)",
"client": "ID for a specific Reseller Client ID (Example: 54374)",
"transcription": "'yes' to enable Voicemail Transcription",
"transcription_locale": "Transcription locale code (values from getLocales, comma separated for more than one locale up to 10 locales)",
"transcription_redaction": "Yes for Transcription redaction (Values: 'yes'/'no')",
"transcription_summary": "Yes for Transcription summary (Values: 'yes'/'no')",
"transcription_sentiment": "Yes for Transcription sentiment (Values: 'yes'/'no')",
"transcription_format": "Transcription format ( Values: 'html'/'text')",
"transcription_delay": "Delay in seconds before voicemail transcription starts. Use 0 for none, or 5 through 60 in steps of 5. Omit this parameter to leave the current value unchanged. (optional)",
"email_attachment_format": "Code for Email Attachment format (Values from getVoicemailAttachmentFormats)",
"unavailable_message_recording": "Recording for the Unavailable Message (values from getRecordings)"
}
},
"method_docs": {
"getBalance": "- Retrieves Balance for your Account if no additional parameter is provided.\n- Retrieves Balance and Calls Statistics for your Account if \"advanced\" parameter is true.",
"getConference": "- Retrieves a list of Conferences if no additional parameter is provided.\n- Retrieves a specific Conference if a conference code is provided.",
"getConferenceMembers": "- Retrieves a list of Member profiles if no additional parameter is provided.\n- Retrieves a specific member if a member code is provided.",
"getConferenceRecordings": "- Retrieves a list of recordings of a specific conference.",
"getConferenceRecordingFile": "- Retrieves a specific Recording File data in Base64 format.",
"getCountries": "- Retrieves a list of Countries if no additional parameter is provided.\n- Retrieves a specific Country if a country code is provided.",
"getIP": "- Shows the IP used by the client application requesting information from the API\n* this is the only function not using the IP for authentication.\n* the IP returned should be the one used in the API Configuration.",
"getLanguages": "- Retrieves a list of Languages if no additional parameter is provided.\n- Retrieves a specific Language if a language code is provided.",
"getLocales": "- Retrieves a list of locale codes if no additional parameter is provided.\n- Retrieves a specific locale code if a language code is provided.",
"getServersInfo": "- Retrieves a list of Servers with their info if no additional parameter is provided.\n- Retrieves a specific Server with its info if a Server POP is provided.",
"getTransactionHistory": "- Retrieves the Transaction History records between two dates.",
"createSubAccount": "- Adds a new Sub Account entry to your Account",
"delSubAccount": "- Deletes a specific Sub Account from your Account",
"getAllowedCodecs": "- Retrieves a list of Allowed Codecs if no additional parameter is provided.\n- Retrieves a specific Allowed Codec if a codec code is provided.",
"getAuthTypes": "- Retrieves a list of Authentication Types if no additional parameter is provided.\n- Retrieves a specific Authentication Type if an auth type code is provided.",
"getDeviceTypes": "- Retrieves a list of Device Types if no additional parameter is provided.\n- Retrieves a specific Device Type if a device type code is provided.",
"getDTMFModes": "- Retrieves a list of DTMF Modes if no additional parameter is provided.\n- Retrieves a specific DTMF Mode if a DTMF mode code is provided.",
"getLockInternational": "- Retrieves a list of Lock Modes if no additional parameter is provided.\n- Retrieves a specific Lock Mode if a lock code is provided.",
"getMusicOnHold": "- Retrieves a list of Music on Hold Options if no additional parameter is provided.\n- Retrieves a specific Music on Hold Option if a MOH code is provided.",
"delMusicOnHold": "- Deletes a specific custom Music on Hold.",
"getNAT": "- Retrieves a list of NAT Options if no additional parameter is provided.\n- Retrieves a specific NAT Option if a NAT code is provided.",
"getProtocols": "- Retrieves a list of Protocols if no additional parameter is provided.\n- Retrieves a specific Protocol if a protocol code is provided.",
"getRegistrationStatus": "- Retrieves the Registration Status of all accounts if no account is provided.",
"getReportEstimatedHoldTime": "- Retrieves a list of 'ReportEstimateHoldTime' Types if no additional parameter is provided.\n- Retrieves a specific 'ReportEstimateHoldTime' Type if a type code is provided.",
"getRoutes": "- Retrieves a list of Route Options if no additional parameter is provided.\n- Retrieves a specific Route Option if a route code is provided.",
"getSubAccounts": "- Retrieves all Sub Accounts if no additional parameter is provided.\n- Retrieves Reseller Client Accounts if Reseller Client ID is provided.\n- Retrieves a specific Sub Account if a Sub Account is provided.",
"getCallTranscriptions": "- Retrieves all Call Transcriptions if no additional parameter is provided.",
"getVoicemailTranscriptions": "- Retrieves all Voicemail Transcriptions if no additional parameter is provided.",
"addMemberToConference": "- Add Member to a Conference",
"setSubAccount": "- Updates Sub Account information.",
"getCallAccounts": "- Retrieves all Sub Accounts if no additional parameter is provided.\n- Retrieves Reseller Client Accounts if Reseller Client ID is provided.",
"getCallBilling": "- Retrieves a list of Call Billing Options.",
"getCallTypes": "- Retrieves a list of Call Types and All DIDs if no additional parameter is provided.\n- Retrieves a list of Call Types and Reseller Client DIDs if a Reseller Client ID is provided.",
"getCDR": "- Retrieves the Call Detail Records of all your calls.",
"getRates": "- Retrieves the Rates for a specific Package and a Search term.",
"getTerminationRates": "- Retrieves the Rates for a specific Route (Premium, Value) and a Search term.",
"getResellerCDR": "- Retrieves the Call Detail Records for a specific Reseller Client.",
"getResellerSMS": "- Retrieves a list of SMS messages for a specific Reseller Client. by: date range, sms type, DID number, and contact",
"getResellerMMS": "- Retrieves a list of MMS messages for a specific Reseller Client. by: date range, mms type, DID number, and contact",
"getCallParking": "- Retrieves all Call Parking entries if no additional parameter is provided.\n- Retrieves a specific Parking entry if a Call Parking ID is provided.",
"setCallParking": "- Updates a specific Call Parking entry if a Call Parking ID is provided.\n- Adds a new Call Parking entry if no Call Parking ID is provided.",
"delCallParking": "- Deletes a specific Call Parking entry from your Account.",
"getCallRecordings": "- Retrieves all call recordings related to account.",
"getCallRecording": "- Retrieves one especific call recording information, including the recording file on mp3 format.",
"sendCallRecordingEmail": "- Send information and audio file to email account.",
"delCallRecording": "- Delete specific call recording, audio file and information related.",
"addCharge": "- Adds a Charge to a specific Reseller Client",
"addPayment": "- Adds a Payment to a specific Reseller Client",
"assignDIDvPRI": "- Assigns a Per Minute DID to a VPRI (Flat Rate DIDs can’t be assigned)",
"getBalanceManagement": "- Retrieves a list of Balance Management Options if no additional parameter is provided.\n- Retrieves a specific Balance Management Option if a code is provided.",
"getCharges": "- Retrieves Charges made to a specific Reseller Client.",
"getClientPackages": "- Retrieves a list of Packages for a specific Reseller Client.",
"getClients": "- Retrieves a list of all Clients if no additional parameter is provided.- Retrieves a specific Reseller Client if a Reseller Client ID is provided.\n- Retrieves a specific Reseller Client if a Reseller Client e-mail is provided.",
"getClientThreshold": "- Retrieves the Threshold Information for a specific Reseller Client.",
"getDeposits": "- Retrieves Deposits made for a specific Reseller Client.",
"getPackages": "- Retrieves a list of Packages if no additional parameter is provided.- Retrieves a specific Package if a package code is provided.",
"getResellerBalance": "- Retrieves Balance and Calls Statistics for a specific Reseller Client for the last 30 days and current day.",
"setClient": "- Updates Reseller Client information.",
"setClientThreshold": "- Update the Threshold Amount for a specific Reseller Client.- Update the Threshold notification e-mail for a specific Reseller Client if the e-mail address is provided.",
"setConference": "- Updates a specific Conference if a conference code is provided.\n- Adds a new Conference entry if no conference code is provided.",
"setConferenceMember": "- Updates a specific Member profile if a member code is provided.\n- Adds a new Member profile entry if no member code is provided.",
"signupClient": "- Signs a new Reseller Client to your Reseller Account.",
"backOrderDIDUSA": "- Backorder DID (USA) from a specific ratecenter and state.",
"backOrderDIDCAN": "- Backorder DID (CANADA) from a specific ratecenter and province.",
"cancelDID": "- Deletes a specific DID from your Account.",
"connectDID": "- Connects a specific DID to a specific Reseller Client Sub Account",
"delCallback": "- Deletes a specific Callback from your Account.",
"delCallerIDFiltering": "- Deletes a specific CallerID Filtering from your Account.",
"delCallHunting": "- Deletes a specific Call Hunting from your Account.",
"delConference": "- Deletes a specific Conference from your Account.",
"delConferenceMember": "- Deletes a specific Member profile from your Account.",
"delClient": "- Deletes a specific reseller client from your Account.",
"delDISA": "- Deletes a specific DISA from your Account.",
"deleteSMS": "- Deletes a specific SMS from your Account.",
"deleteMMS": "- Deletes a specific MMS from your Account.",
"delForwarding": "- Deletes a specific Forwarding from your Account.",
"delIVR": "- Deletes a specific IVR from your Account.",
"delPhonebook": "- Deletes a specific Phonebook from your Account.",
"delPhonebookGroup": "- Deletes a specific Phonebook group from your Account.",
"delQueue": "- Deletes a specific Queue from your Account.",
"delRecording": "- Deletes a specific Recording from your Account.",
"delRingGroup": "- Deletes a specific Ring Group from your Account.",
"delSIPURI": "- Deletes a specific SIP URI from your Account.",
"delStaticMember": "- Deletes a specific Static Member from Queue.",
"delTimeCondition": "- Deletes a specific Time Condition from your Account.",
"getCallbacks": "- Retrieves a list of Callbacks if no additional parameter is provided.\n- Retrieves a specific Callback if a Callback code is provided.",
"getCallerIDFiltering": "- Retrieves a list of CallerID Filterings if no additional parameter is provided.\n- Retrieves a specific CallerID Filtering if a CallerID Filtering code is provided.",
"getCallHuntings": "- Retrieves a list of Call Huntings if no additional parameter is provided.\n- Retrieves a specific Call Huntings if a Call Hunting code is provided.",
"getCarriers": "- Retrieves a list of Carriers for Vanity Numbers if no additional parameter is provided.\n- Retrieves a specific Carrier for Vanity Numbers if a carrier code is provided.",
"getDIDCountries": "- Retrieves a list of Countries for International DIDs if no country code is provided.\n- Retrieves a specific Country for International DIDs if a country code is provided.",
"getDIDsCAN": "- Retrives a list of Canadian DIDs by Province and Ratecenter.",
"getDIDsInfo": "- Retrieves information from all your DIDs if no additional parameter is provided.\n- Retrieves information from Reseller Client's DIDs if a Reseller Client ID is provided.\n- Retrieves information from Sub Account's DIDs if a Sub Accunt is provided.\n- Retrieves information from a specific DID if a DID Number is provided.\n- Retrieves SMS information from a specific DID if the SMS is available.",
"getDIDsInternationalGeographic": "- Retrieves a list of International Geographic DIDs by Country.",
"getDIDsInternationalNational": "- Retrieves a list of International National DIDs by Country.",
"getDIDsInternationalTollFree": "- Retrieves a list of International TollFree DIDs by Country.",
"getDIDsUSA": "- Retrives a list of USA DIDs by State and Ratecenter.",
"getDIDvPRI": "- Retrives the list of DIDs assigned to the VPRI.",
"getDISAs": "- Retrieves a list of DISAs if no additional parameter is provided.\n- Retrieves a specific DISA if a DISA code is provided.",
"getForwardings": "- Retrieves a list of Forwardings if no additional parameter is provided.\n- Retrieves a specific Forwarding if a fwd code is provided.",
"getInternationalTypes": "- Retrieves a list of Types for International DIDs if no additional parameter is provided.\n- Retrieves a specific Types for International DIDs if a type code is provided.",
"getIVRs": "- Retrieves a list of IVRs if no additional parameter is provided.\n- Retrieves a specific IVR if a IVR code is provided.",
"getJoinWhenEmptyTypes": "- Retrieves a list of 'JoinWhenEmpty' Types if no additional parameter is provided.\n- Retrieves a specific 'JoinWhenEmpty' Types if a type code is provided.",
"getMMS": "- Retrieves a list of MMS messages by: date range, mms type, DID number, and contact.",
"getMediaMMS": "- Retrieves media files from the message.",
"getPhonebook": "- Retrieves a list of Phonebook entries if no additional parameter is provided.\n- Retrieves a list of Phonebook entries if a name is provided.\n- Retrieves a specific Phonebook entry if a Phonebook code is provided.\n- Retrieves a list of Phonebook entries if a phonebook group name is provided.\n- Retrieves a list of Phonebook entries if a phonebook group code is provided.",
"getPhonebookGroups": "- Retrieves a list of Phonebook groups if no additional parameter is provided.\n- Retrieves a list of Phonebook groups if a name is provided.\n- Retrieves a specific Phonebook group if a group ID is provided.",
"getPortability": "- Shows if a DID Number can be ported into our network.\n- Display plans and rates available if the DID Number can be ported into our network.",
"getProvinces": "- Retrieves a list of Canadian Provinces.",
"getQueues": "- Retrieves a list of Queue entries if no additional parameter is provided.\n- Retrieves a specific Queue entry if a Queue code is provided.",
"getRateCentersCAN": "- Retrieves a list of Canadian Ratecenters by Province.",
"getRateCentersUSA": "- Retrieves a list of USA Ratecenters by State.",
"getRecordings": "- Retrieves a list of Recordings if no additional parameter is provided.\n- Retrieves a specific Recording if a Recording code is provided.",
"getRecordingFile": "- Retrieves a specific Recording File data in Base64 format.",
"getRingGroups": "- Retrieves a list of Ring Groups if no additional parameter is provided.\n- Retrieves a specific Ring Group if a ring group code is provided.",
"getRingStrategies": "- Retrieves a list of Ring Strategies if no additional parameter is provided.\n- Retrieves a specific Ring Strategy if a ring strategy code is provided.",
"getSIPURIs": "- Retrieves a list of SIP URIs if no additional parameter is provided.\n- Retrieves a specific SIP URI if a SIP URI code is provided.",
"getSMS": "- Retrieves a list of SMS messages by: date range, sms type, DID number, and contact.",
"getStates": "- Retrieves a list of USA States.",
"getStaticMembers": "- Retrieves a list of Static Members from a queue if no additional parameter is provided.\n- Retrieves a specific Static Member from a queue if Queue ID and Member ID are provided",
"getTimeConditions": "- Retrieves a list of Time Conditions if no additional parameter is provided.\n- Retrieves a specific Time Condition if a time condition code is provided.",
"getVoicemailSetups": "- Retrieves a list of Voicemail Setup Options if no additional parameter is provided.\n- Retrieves a specific Voicemail Setup Option if a voicemail setup code is provided.",
"getVoicemailAttachmentFormats": "- Retrieves a list of Email Attachment Format Options if no additional parameter is provided.\n- Retrieves a specific Email Attachment Format Option if a format value is provided.",
"orderDID": "- Orders and Adds a new DID Number to the Account.",
"orderDIDInternationalGeographic": "- Orders and Adds new International Geographic DID Numbers to the Account.",
"orderDIDInternationalNational": "- Orders and Adds new International National DID Numbers to the Account.",
"orderDIDInternationalTollFree": "- Orders and Adds new International TollFree DID Numbers to the Account.",
"orderDIDVirtual": "- Orders and Adds a new Virtual DID Number to the Account.",
"orderTollFree": "- Orders and Adds a new Toll Free Number to the Account.",
"orderVanity": "- Orders and Adds a new Vanity Toll Free Number to the Account.",
"removeDIDvPRI": "- Removes a DID from a VPRI",
"searchDIDsCAN": "- Searches for Canadian DIDs by Province using a Search Criteria.",
"searchDIDsUSA": "- Searches for USA DIDs by State using a Search Criteria.",
"searchTollFreeCanUS": "- Searches for USA/Canada Toll Free Numbers using a Search Criteria.\n- Shows all USA/Canada Toll Free Numbers available if no criteria is provided.",
"searchTollFreeUSA": "- Searches for USA Toll Free Numbers using a Search Criteria.\n- Shows all USA Toll Free Numbers available if no criteria is provided.",
"searchVanity": "- Searches for Vanity Toll Free Numbers using a Search Criteria.",
"sendSMS": "- Send a SMS message to a Destination Number.",
"sendMMS": "- Send a MMS message to a Destination Number.",
"setCallback": "- Updates a specific Callback if a callback code is provided.\n- Adds a new Callback entry if no callback code is provided.",
"setCallerIDFiltering": "- Updates a specific Caller ID Filtering if a filtering code is provided.\n- Adds a new Caller ID Filtering if no filtering code is provided.",
"setCallHunting": "- Updates a specific Call Hunting if a Call Hunting code is provided.\n- Adds a new Call Hunting if no Call Hunting code is provided.",
"setDIDBillingType": "- Updates the Billing Plan from a specific DID.",
"setDIDInfo": "- Updates the information from a specific DID.",
"setDIDPOP": "- Updates the POP from a specific DID.",
"setDIDRouting": "- Updates the Routing from a specific DID.",
"setDIDVoicemail": "- Updates the Voicemail from a specific DID.",
"setDISA": "- Updates a specific DISA if a disa code is provided.\n- Adds a new DISA entry if no disa code is provided.",
"setForwarding": "- Updates a specific Forwarding if a fwd code is provided.\n- Adds a new Forwarding entry if no fwd code is provided.",
"setIVR": "- Updates a specific IVR if an IVR code is provided.\n- Adds a new IVR entry if no IVR code is provided.",
"setPhonebook": "- Updates a specific Phonebook entry if a phonebook code is provided.\n- Adds a new Phonebook entry if no phonebook code is provided.",
"setPhonebookGroup": "- Updates a specific Phonebook group if a phonebook code is provided.\n- Adds a new Phonebook group if no phonebook group code is provided.\n- Assigns or modifies group members if a member list is provided",
"setQueue": "- Updates a specific Queue entry if a queue code is provided.\n- Adds a new Queue entry if no queue code is provided.",
"setRecording": "- Updates a specific Recording File if a Recording ID is provided.\n- Adds a new Recording file entry if no Recording ID is provided.",
"setRingGroup": "- Updates a specific Ring Group if a ring group code is provided.\n- Adds a new Ring Group entry if no ring group code is provided.",
"setSIPURI": "- Updates a specific SIP URI if a SIP URI code is provided.\n- Adds a new SIP URI entry if no SIP URI code is provided.",
"setSMS": "- Enable/Disable the SMS Service for a DID\n- Change the SMS settings for a DID",
"setStaticMember": "- Updates a specific Member from queue if a Member code is provided.\n- Adds a new Member to Queue if no Member code is provided.",
"setTimeCondition": "- Updates a specific Time Condition if a time condition code is provided.\n- Adds a new Time Condition entry if no time condition code is provided.",
"unconnectDID": "- Unconnects specific DID from Reseller Client Sub Account.",
"connectFAX": "- Connects a specific FAX DID to a specific Reseller Client Sub Account",
"unconnectFAX": "- Unconnects specific FAX DID from Reseller Client Sub Account.",
"cancelFaxNumber": "- Deletes a specific Fax Number from your Account.",
"deleteFaxMessage": "- Deletes a specific Fax Message from your Account.",
"delEmailToFax": "- Deletes a specific \"Email to Fax configuration\" from your Account.",
"delFaxFolder": "- Deletes a specific Fax Folder from your Account.",
"getBackOrders": "- Retrieves a list of backorder DIDs if no additional parameter is provided.\n- Retrieves a specific backorder DID if a backorder DID code is provided.",
"getFaxProvinces": "- Retrieves a list of Canadian Fax Provinces if no additional parameter is provided.\n- Retrieves a specific Canadian Fax Province if a province code is provided.",
"getFaxStates": "- Retrieves a list of American Fax States if no additional parameter is provided.\n- Retrieves a specific American Fax State if a state code is provided.",
"getFaxRateCentersCAN": "- Retrieves a list of Canadian Ratecenters by Province.",
"getFaxRateCentersUSA": "- Retrieves a list of USA Ratecenters by State.",
"getFaxNumbersInfo": "- Retrieves a list of Fax Numbers.",
"getFaxNumbersPortability": "- Shows if a Fax Number can be ported into our network",
"getFaxMessages": "- Retrieves a list of Fax Messages.\n- Retrieves a specific Fax Message if a Fax Message ID is provided.",
"getFaxMessagePDF": "- Retrieves a Base64 code of the Fax Message to create a PDF file.",
"getFaxFolders": "- Retrieves a list of Fax Folders from your account.",
"getEmailToFax": "- Retrieves a list of \"Email to Fax configurations\" from your account if no additional parameter is provided.\n- Retrieves a specific \"Email to Fax configuration\" from your account if a ID is provided.",
"mailFaxMessagePDF": "- Send a Fax Message attached as a PDF file to an email destination.",
"moveFaxMessage": "- Moves a Fax Message to a different folder.",
"orderFaxNumber": "- Orders and Adds a new Fax Number to the Account.",
"setFaxFolder": "- Create or update the information of a specific Fax Folder.",
"setEmailToFax": "- Create or update the information of a specific \"Email to Fax configuration\".",
"searchFaxAreaCodeCAN": "- Retrieves a list of Canadian Ratecenters searched by Area Code.",
"searchFaxAreaCodeUSA": "- Retrieves a list of USA Ratecenters searched by Area Code.",
"setFaxNumberInfo": "- Updates the information from a specific Fax Number.",
"setFaxNumberEmail": "- Updates the email configuration from a specific Fax Number.",
"setFaxNumberURLCallback": "- Updates the url callback configuration from a specific Fax Number.",
"sendFaxMessage": "- Send a Fax message to a Destination Number.",
"e911AddressTypes": "- Retrieves a list of e911 Address Types if no additional parameter is provided.\n- Retrieves a specific e911 Address Type if an Address code is provided.",
"e911Cancel": "- Cancel the e911 Service from a specific DID.",
"e911Info": "- Retrieves the e911 information from a specific DID.",
"e911Provision": "- Subscribes your DID to the e911 Emergency Services.",
"e911ProvisionManually": "- Subscribes your DID to the e911 Emergency Services.\n- All e911 information will be validated by the VoIP.ms staff.",
"e911Update": "- Updates the Information from your e911 Emergency Services Subscription.",
"e911Validate": "- Validates your e911 information in order to start your e911 Emergency Services Subscription.",
"addLNPPort": "- Add one or more numbers to start a portability process.",
"addLNPFile": "- Add an invoice file to a portability process.",
"getLNPStatus": "- Retrieve the current status of a given portability process.",
"getLNPNotes": "- Retrieve the list of notes from the given portability process.",
"getLNPListStatus": "- Retrieve the list of possible status of a portability process.",
"getLNPList": "- Retrieve the full list of all your portability processes.",
"getLNPDetails": "- Retrieve the details of a given portability process.",
"getLNPAttachList": "- Retrieve the list of invoice (attached) files from a given portability process.",
"getLNPAttach": "- Retrieve the details of an attached invoice.",
"createVoicemail": "- Adds a new Voicemail entry to your Account",
"delMessages": "- Deletes all messages in all servers from a specific Voicemail from your Account",
"delMemberFromConference": "- Removes a member profile from a specific Conference from your Account",
"delVoicemail": "- Deletes a specific Voicemail from your Account",
"getPlayInstructions": "- Retrieves a list of Play Instructions modes if no additional parameter is provided.\n- Retrieves a specific Play Instructions mode if a play code is provided.",
"getTimezones": "- Retrieves a list of Timezones if no additional parameter is provided.\n- Retrieves a specific Timezone if a timezone code is provided.",
"getVoicemails": "- Retrieves a list of Voicemails if no additional parameter is provided.\n- Retrieves a specific Voicemail if a voicemail code is provided.",
"getVoicemailFolders": "- Retrieves a list of default Voicemail Folders if no additional parameter is provided.\n- Retrieves a list of Voicemail Folders within a mailbox if mailbox parameter is provided.\n- Retrieves a specific Folder if a folder name is provided.",
"getVoicemailMessageFile": "- Retrieves a specific Voicemail Message File in Base64 format.",
"getVoicemailMessages": "- Retrieves a list of Voicemail Messages if mailbox parameter is provided.\n- Retrieves a list of Voicemail Messages in a Folder if a folder is provided.\n- Retrieves a list of Voicemail Messages in a date range if a from and to are provided.",
"getVPRIs": "- Retrieves a list of vpri.",
"markListenedVoicemailMessage": "- Mark a Voicemail Message as Listened or Unlistened.\n- If value is 'yes', the voicemail message will be marked as listened and will be moved to the Old Folder.\n- If value is 'no', the voicemail message will be marked as not-listened and will be moved to the INBOX Folder.",
"markUrgentVoicemailMessage": "- Mark Voicemail Message as Urgent or not Urgent.\n- If value is 'yes', the voicemail message will be marked as urgent and will be moved to the Urgent Folder.\n- If value is 'no', the voicemail message will be unmarked as urgent and will be moved to the INBOX Folder.",
"moveFolderVoicemailMessage": "- Move Voicemail Message to a Destination Folder.",
"sendVoicemailEmail": "- Send a Voicemail Message File to an Email Address.",
"setVoicemail": "- Updates the information from a specific Voicemail."
}
}