API: SIP

JSON Object Example

Fields description 

Field

Type

Description

UserName

String

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

Example:
"UserName""917"

Server

String

Domain address or an IP address of a PBX or VOIP Service provider.

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

AuthorizationName

String

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

Example:
"AuthorizationName""917"

Password

String

This field contains a password for SIP authentication

Example:
"Password""password"

DisplayName

String

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

Example:
"DisplayName""any_name"

Number

String

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

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

When enabled – call will be performed.

Example:
"PerformCall"true

ExpectedCallResult

String

This field contains designation for an expected behavior of called party.POSSIBLE VALUES: “Answer”, “Busy”, “No Answer”

Example:
"ExpectedCallResult""Answer"

Device_Id

Int32

READ ONLY Field.Unique device id

Example:
"Device_Id": 8692

Id

Int32

READ ONLY Field.Unique task id

Example:
"Id": 18014

Task_Type_Id

Int32

Type of the task field. Please check Potential values for Task_type_id in appropriate table

Example:
"Task_Type_Id": 51

Name

string

Task name

Example:
"Name""sip"

Timeout

Int32

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

Example:
"Timeout": 100