JSON Object Example
{
    "Timeout": 511000,
    "UserName": "134",
    "Server": "asterisk.company.com:3434",
    "AuthorizationName": "134",
    "Password": "pass",
    "DisplayName": "134",
    "Number": "104",
    "PerformRegister": true,
    "PerformCall": true,
    "ExpectedCallResult": "Answer",
    "UseTLS": false,
    "UseSRTP": false,
    "DNSResolveMode": "Device Cached",
    "DNSserverIP": "",
    "CustomDNSHosts": null,
    "Device_Id": 63667,
    "Id": 159295,
    "Task_Type_Id": 17,
    "Name": "asterisk.dana-net.com"
}

Fields Description

Field

Type

Required/Optional

 Description

UserName

string

required

 This field contains your username (usually like “username@domain.com”) in a source domain (server).

Example:
"UserName": "254"

Server

string

required

 Domain address or an IP address of a PBX or VOIP Service provider. To specify a destination port (if necessary), use the server:port format.

Example:
"Server": "asterisk.company.com:3434"

AuthorizationName

string

required

 This field contains name used for an authentications sessions, usually it matches username.

Example:
"AuthorizationName": "254"

Password

string

optional

 This field contains a password for SIP authentication.

Example:
"Password": "password"

DisplayName

string

optional

 So called “Friendly name” or “Display name” (according to RFC 3261).

Example:
"DisplayName": "any_name"

Number

string

required

*If  “PerformCall” : true

 This field contains destination number. In case you perform monitoring of the number located in another domain (belongs to another PBX) you may have to specify number (name) and domain name in the following format: number(name)@destination_domain.com. Domains can be specified directly by their IP addresses.

Example:
"Number": "918"

PerformRegister

boolean

required

*If  “PerformCall” : false

 Registration process creates binding between caller ID (SIP URL like “username@domain.com“) and its address. Please see RFC 3261 paragraph 10 for more information.

Example:
"PerformRegister": true

PerformCall

boolean

required

*If  “PerformRegister” : false

 When enabled – call will be performed.

Example:
"PerformCall": true

ExpectedCallResult

string

required

*If  “PerformCall” : true

 This field contains designation for an expected behavior of called party.

POSSIBLE VALUES:

  • Answer
  • Busy
  • No Answer
Example:
"ExpectedCallResult": "Answer"

Device_Id

int32

required

 READ ONLY Field. The unique device id.

Example:
"Device_Id": 8692

Id

int32

required

*Only for edit operations

 READ ONLY Field. The unique task id. Do not use for create operations.

Example:
"Id": 18014

Task_Type_Id

int32

required

 The type id of the task.

Example:
"Task_Type_Id": 17

Name

string

optional

 Task name.

Example:
"Name": "sip"

Timeout

int32

optional

 This field defines maximum time value (in seconds) for task execution.

Example:
"Timeout": 100