Page Comparison

_{You can test API methods on the}_{interactive API browser}_{page and without writing code}
_{Some of the resources described on the page may not be available by default due to the type of application (see}_{Creating and authorizing applications}_).

Description of data structures

Expand

title	Expand

Name	Type	Description
ambassadors	string	Contact persons
contact_phones	string	Contact phone numbers
create_date	string	Creation date
dial_rule_id	long	ID of the outgoing call rule
did_as_transfer_caller_id	string	The external PBX number that the call originally came to, which is displayed when the number is further forwarded
disk_space_notify_email	string	The e-mail address to which the message will be sent when the disk space threshold is reached (disk_space_notify_threshold)
disk_space_notify_threshold	long	The notification threshold (in %) when the disk space size threshold is reached, at which sending a message to the e-mail address specified in disk_space_notify_email will be triggered
domain	string	Domain
domain_prefix	string	The domain prefix. Used for full internal number dialing. For example, with the prefix "12345", the internal number is 000000@domain.zone can be called by the number "12345000*000"
email	string	Email address
extension_len	string	Length of internal numbers
extra_params	string	Additional parameters
fact_address	string	Actual address
geo_list	string	Sets the list of countries from which IP addresses the use of the SIP account is allowed. Countries are listed in the ISO 3166 Codes A2 format, for example: "RU US BY". If the list is not specified, the value defined by the service provider is used. If the list is set to "*", then all countries are allowed and the service provider parameter is ignored
hold_music	long	ID of the sound file to play while holding a call
id	long	Client ID
jur_address	string	Legal address
language	string	Language
name	string	Client name
prefix	string	Client prefix
presence	string	yes/no: monitoring the availability of internal PBX numbers without calling them (green - free, you can transfer the call; red - busy)
record_format	string	Conversation recording format, default mp3
record_stereo	boolean	true/false: determines whether conversations are recorded in stereo format, by default false
reg_status_log	boolean	true/false: determines whether internal number registration statistics are maintained. This parameter is set by the service provider.
short_local_caller_id	string	Short internal caller ID (displaying the internal number without the PBX prefix)
sip_network_permission_id	long	ID of the trusted SIP network. Phones can be authorized by IP addresses; if this parameter is set, this is a list of IP addresses from which calls can be made in this organization
timezone	string	Client's time zone
type	string	Client type: J - legal entity, F - individual

Example

We get information about the current authorized client. To do this, let's send the following request:

…

Tabs

[{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"In the authentication section enter the "},{"type":"text","text":"Application_ID","marks":[{"type":"strong"}]},{"type":"text","text":" and "},{"type":"text","text":"Application_Secret","marks":[{"type":"strong"}]},{"type":"text","text":" values obtained during the application registration in the "},{"type":"text","text":"client_id ","marks":[{"type":"strong"}]},{"type":"text","text":"and "},{"type":"text","text":"client_secret","marks":[{"type":"strong"}]},{"type":"text","text":" fields, then click on the \""},{"type":"text","text":"Try it out!","marks":[{"type":"strong"}]},{"type":"text","text":"\" button. If the application data is correct, an access token ("},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":") will be returned in response. The received access token should be entered into the \""},{"type":"text","text":"Access Token Field","marks":[{"type":"strong"}]},{"type":"text","text":"\" at the top of the page and saved by clicking the \""},{"type":"text","text":"Set Token","marks":[{"type":"strong"}]},{"type":"text","text":"\" button."}]},{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"Method","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"Resourse","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"Data","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"GET"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/client/@me/client/"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":" "}]}]}]}]},{"type":"paragraph","content":[]}]},"id":"0b22a425-f754-4325-a6b3-6ca77b596f0b","label":"Interactive API Browser","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"To send requests using the cURL program, set the values of the "},{"type":"text","text":"url ","marks":[{"type":"strong"}]},{"type":"text","text":"and "},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":" variables:"}]},{"type":"paragraph","content":[{"type":"text","text":"export url=\"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(where the hostname — is the hostname of the API-server provider of IP-telephony),"}]},{"type":"paragraph","content":[{"type":"text","text":"export access_token=\"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(the received access token)."}]},{"type":"paragraph","content":[{"type":"text","text":"Send a request:"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\n-H \"Authorization: Bearer ${access_token}\" \\\n-X GET ${url}/client/@me/client/"}]}]},"id":"867a14a9-4015-4d3c-bd05-7c518a16fc12","label":"cURL Program","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"To send requests in Python, set the values of the variables URL and ACCESS_TOKEN:"}]},{"type":"paragraph","content":[{"type":"text","text":"URL = \"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(where the hostname — is the hostname of the API-server provider of IP-telephony),"}]},{"type":"paragraph","content":[{"type":"text","text":"ACCESS_TOKEN = \"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(the received access token)."}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\n\nimport requests\n\nurl = f\"{URL}/client/@me/client/\"\nheaders = {\n    'Authorization': f'Bearer {ACCESS_TOKEN}'\n}\nresponse = requests.request(\"GET\", url, headers=headers)\nprint(response.text)"}]}]},"id":"4689b14a-14b4-48c5-81bb-744cc0017d36","label":"In Python3","type":"tab"}]

Expand

title	System response:

Code Block

language	json

{
  "domain": " sip.ringme.ru",
  "create_date": "2020-03-16 09:29:57",
  "hold_music": null,
  "presence": "no",
  "sip_network_permission_id": null,
  "prefix": "0001",
  "record_stereo": false,
  "ambassadors": null,
  "id": 12,
  "domain_prefix": "00001",
  "contact_phones": null,
  "name": "ringme_test",
  "timezone": "Europe/Moscow",
  "dial_rule_id": 19,
  "type": "J",
  "email": "admin@domain.com",
  "reg_status_log": false,
  "fact_address": null,
  "extra_params": null,
  "extension_len": 3,
  "geo_list": null,
  "did_as_transfer_caller_id": "default",
  "jur_address": null,
  "language": null,
  "record_format": "mp3",
  "short_local_caller_id": "yes",
  "disk_space_notify_email": null,
  "disk_space_notify_threshold": null
}

Resources of the "Client" section

Expand

title	GET /client/{client_id}/client/ or GET /client/client_info/{client_id}/

GET /client/{client_id}/client/,

or GET /client/client_info/{client_id}/

Get client data

URL Parameters

Name	Type
client_id	string

Response fields

Name	Type
ambassadors	string
contact_phones	string
create_date	string
dial_rule_id	long
did_as_transfer_caller_id	string
disk_space_notify_email	string
disk_space_notify_threshold	long
domain	string
domain_prefix	string
email	string
extension_len	string
extra_params	string
fact_address	string
geo_list	string
hold_music	long
id	long
jur_address	string
language	string
name	string
prefix	string
presence	string
record_format	string
record_stereo	boolean
reg_status_log	boolean
short_local_caller_id	string
sip_network_permission_id	long
timezone	string
type	string

Expand

title	PUT /client/{client_id}/client/, либо PUT /client/client_info/{client_id}/

PUT /client/{client_id}/client/,

or PUT /client/client_info/{client_id}/

Update client settings (not all parameters for updating are available to the client)

URL Parameters

Name	Type
client_id	string

JSON parameters

Name	Type
dial_rule_id	long
disk_space_notify_email	string
disk_space_notify_threshold	long
geo_list	string
hold_music	long
sip_network_permission_id	long
timezone	string

Response fields

Name	Type
ambassadors	string
contact_phones	string
create_date	string
dial_rule_id	long
did_as_transfer_caller_id	string
disk_space_notify_email	string
disk_space_notify_threshold	long
domain	string
domain_prefix	string
email	string
extension_len	string
extra_params	string
fact_address	string
geo_list	string
hold_music	long
id	long
jur_address	string
language	string
name	string
prefix	string
presence	string
record_format	string
record_stereo	boolean
reg_status_log	boolean
short_local_caller_id	string
sip_network_permission_id	long
timezone	string
type	string

Versions Compared

Old Version 2

New Version Current

Key

Description of data structures

Example

Resources of the "Client" section