Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Description

status

string

domain

string

dial_rule_limit

integer

from_public_caller_id_number

boolean

Default: False

extra_params

string

name

string

rfc_public_caller_id_number

boolean

Default: False

extension_group_id

integer

public_caller_id_number

string

label

string

caller_id_name

string

client_id

integer

dial_rule_id

integer

message_did

string

create_date

string

ani_rfc3325

boolean

type

string

id

integer

Resource id.

did_as_transfer_caller_id

string

...

POST /dealer/{dealer_id}/extension/call_status/

Post dealer extension call status

Path parameters

Name

Type

Description

dealer_id

string

Required.

JSON parameters

Name

Type

Description

property_list

array [string]

Required.

name

string

Required.

Resource fields

Name

Type

Description

create_dt

string

name

string

property_list

array [string]

admin_extra_params

object

extra_params

object

id

integer

Resource id.

GET /dealer/{dealer_id}/extension/call_status/

Get dealer extension call status list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Resource fields

Name

Type

Description

create_dt

string

name

string

property_list

array [string]

admin_extra_params

object

extra_params

object

id

integer

Resource id.

...

PUT /dealer/{dealer_id}/extension/call_status/{id}

Update dealer extension call status

Path parameters

Name

Type

Description

dealer_id

string

Required.

id

integer

Required. Resource id.

JSON parameters

Name

Type

Description

property_list

array [string]

name

string

Resource fields

Name

Type

Description

create_dt

string

name

string

property_list

array [string]

admin_extra_params

object

extra_params

object

id

integer

Resource id.

GET /dealer/{dealer_id}/extension/call_status/{id}

Get dealer extension call status

Path parameters

Name

Type

Description

dealer_id

string

Required.

id

integer

Required. Resource id.

Resource fields

Name

Type

Description

create_dt

string

name

string

property_list

array [string]

admin_extra_params

object

extra_params

object

id

integer

Resource id.

DELETE /dealer/{dealer_id}/extension/call_status/{id}

Delete dealer extension call status

Path parameters

Name

Type

Description

dealer_id

string

Required.

id

integer

Required. Resource id.

...

GET /dealer/{dealer_id}/extension/search/

Extension search

Path parameters

Name

Type

Description

dealer_id

string

Required.

...

Name

Type

Description

page

integer

Default: 1

per_page

integer

q

string

Required.

Resource fields

Name

Type

Description

total_count

integer

result

array [extension_search]

...

POST /dealer/{dealer_id}/interval/

Add interval

Path parameters

Name

Type

Description

dealer_id

string

Required.

JSON parameters

Name

Type

Description

timezone

string

Required. Interval timezone.

conditions

array [condition]

Required. Datetime conditions.

name

string

Required. Interval name.

...

Name

Type

Description

start_datetime

string

Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

start_dow

integer

Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_skip_days

integer

Min: 1.

sched_start_date

string

Start datetime formatted as yyyy-mm-dd.

month

integer

Month. Min: 1. Max: 12.

end_dow

integer

End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_active_days

integer

Min: 1.

end_mday

integer

End month day. Min: 1. Max: 31.

start_mday

integer

Start month day. Min: 1. Max: 31.

end_time

string

End time of day.

start_time

string

Start time of day.

end_datetime

string

End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

Resource fields

Name

Type

Description

dealer_id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

...

GET /dealer/{dealer_id}/interval/

Get interval list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Resource fields

Name

Type

Description

dealer_id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

...

PUT /dealer/{dealer_id}/interval/{interval_id}

Update interval

Path parameters

Name

Type

Description

dealer_id

string

Required.

interval_id

integer

Required.

JSON parameters

Name

Type

Description

timezone

string

Required. Interval timezone.

conditions

array [condition]

Required. Datetime conditions.

name

string

Required. Interval name.

...

Name

Type

Description

start_datetime

string

Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

start_dow

integer

Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_skip_days

integer

Min: 1.

sched_start_date

string

Start datetime formatted as yyyy-mm-dd.

month

integer

Month. Min: 1. Max: 12.

end_dow

integer

End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_active_days

integer

Min: 1.

end_mday

integer

End month day. Min: 1. Max: 31.

start_mday

integer

Start month day. Min: 1. Max: 31.

end_time

string

End time of day.

start_time

string

Start time of day.

end_datetime

string

End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

Resource fields

Name

Type

Description

dealer_id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

...

GET /dealer/{dealer_id}/interval/{interval_id}

Get interval

Path parameters

Name

Type

Description

dealer_id

string

Required.

interval_id

integer

Required.

Resource fields

Name

Type

Description

dealer_id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

...

DELETE /dealer/{dealer_id}/interval/{interval_id}

Delete interval

Path parameters

Name

Type

Description

dealer_id

string

Required.

interval_id

integer

Required.

...

POST /dealer/{dealer_id}/sound/

Add sound

Path parameters

Name

Type

Description

dealer_id

string

Required.

...

Name

Type

Description

title

string

Required. Sound title.

file

file

Required.

Resource fields

Name

Type

Description

title

string

Sound title.

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

GET /dealer/{dealer_id}/sound/

Get sound list

Path parameters

Name

Type

Description

dealer_id

string

Required.

...

Name

Type

Description

page

integer

Default: 1

per_page

integer

id

array [integer]

title

array [string]

Resource fields

Name

Type

Description

title

string

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

...

PUT /dealer/{dealer_id}/sound/{sound_id}

Update sound

Path parameters

Name

Type

Description

dealer_id

string

Required.

sound_id

integer

Required.

JSON parameters

Name

Type

Description

title

string

Sound title.

Resource fields

Name

Type

Description

title

string

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

GET /dealer/{dealer_id}/sound/{sound_id}

Get sound

Path parameters

Name

Type

Description

dealer_id

string

Required.

sound_id

integer

Required.

Resource fields

Name

Type

Description

title

string

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

DELETE /dealer/{dealer_id}/sound/{sound_id}

Delete sound

Path parameters

Name

Type

Description

dealer_id

string

Required.

sound_id

integer

Required.

...

GET /dealer/{dealer_id}/sound/{sound_id}/download/

Get sound file

Path parameters

Name

Type

Description

dealer_id

string

Required.

sound_id

integer

Required.

...

POST /dealer/{dealer_id}/template/

Add dealer template

Path parameters

Name

Type

Description

dealer_id

string

Required.

JSON parameters

Name

Type

Description

body

string

Required.

from_name

string

Required.

from_address

string

Required.

language

string

Required. One of 'default', 'ab', 'aa', 'af', 'ak', 'sq', 'am', 'ar', 'an', 'hy', 'as', 'av', 'ae', 'ay', 'az', 'bm', 'ba', 'eu', 'be', 'bn', 'bh', 'bi', 'bs', 'br', 'bg', 'my', 'ca', 'ch', 'ce', 'ny', 'zh', 'cv', 'kw', 'co', 'cr', 'hr', 'cs', 'da', 'dv', 'nl', 'dz', 'en', 'eo', 'et', 'ee', 'fo', 'fj', 'fi', 'fr', 'ff', 'gl', 'ka', 'de', 'el', 'gn', 'gu', 'ht', 'ha', 'he', 'hz', 'hi', 'ho', 'hu', 'ia', 'id', 'ie', 'ga', 'ig', 'ik', 'io', 'is', 'it', 'iu', 'ja', 'jv', 'kl', 'kn', 'kr', 'ks', 'kk', 'km', 'ki', 'rw', 'ky', 'kv', 'kg', 'ko', 'ku', 'kj', 'la', 'lb', 'lg', 'li', 'ln', 'lo', 'lt', 'lu', 'lv', 'gv', 'mk', 'mg', 'ms', 'ml', 'mt', 'mi', 'mr', 'mh', 'mn', 'na', 'nv', 'nd', 'ne', 'ng', 'nb', 'nn', 'no', 'ii', 'nr', 'oc', 'oj', 'cu', 'om', 'or', 'os', 'pa', 'pi', 'fa', 'pl', 'ps', 'pt', 'qu', 'rm', 'rn', 'ro', 'ru', 'sa', 'sc', 'sd', 'se', 'sm', 'sg', 'sr', 'gd', 'sn', 'si', 'sk', 'sl', 'so', 'st', 'es', 'su', 'sw', 'ss', 'sv', 'ta', 'te', 'tg', 'th', 'ti', 'bo', 'tk', 'tl', 'tn', 'to', 'tr', 'ts', 'tt', 'tw', 'ty', 'ug', 'uk', 'ur', 'uz', 've', 'vi', 'vo', 'wa', 'cy', 'wo', 'fy', 'xh', 'yi', 'yo', 'za', 'zu'.

type

string

Required. One of 'password_reset', 'call_failed_mail', 'record_archive', 'fax_delivery_success', 'fax_delivery_fail', 'email_to_fax_confirm', 'email_to_fax_fail', 'low_disk_space', 'voicemail', 'fax_to_email', 'create_user', 'create_user_extension', 'create_user_extension_group', 'call_center_report'.

subject

string

Required.

Resource fields

Name

Type

Description

body

string

from_name

string

from_address

string

language

string

type

string

subject

string

GET /dealer/{dealer_id}/template/

Get dealer template list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Resource fields

Name

Type

Description

body

string

from_name

string

from_address

string

language

string

type

string

subject

string

...

PUT /dealer/{dealer_id}/template/{type}/{language}

Update dealer template

Path parameters

Name

Type

Description

dealer_id

string

Required.

type

string

Required.

language

string

Required.

JSON parameters

Name

Type

Description

body

string

from_name

string

from_address

string

subject

string

Resource fields

Name

Type

Description

body

string

from_name

string

from_address

string

language

string

type

string

subject

string

GET /dealer/{dealer_id}/template/{type}/{language}

Get dealer template

Path parameters

Name

Type

Description

dealer_id

string

Required.

type

string

Required.

language

string

Required.

Resource fields

Name

Type

Description

body

string

from_name

string

from_address

string

language

string

type

string

subject

string

DELETE /dealer/{dealer_id}/template/{type}/{language}

Delete dealer template

Path parameters

Name

Type

Description

dealer_id

string

Required.

type

string

Required.

language

string

Required.

...

POST /dealer/{dealer_id}/user/dealer/

Add new user dealer

Path parameters

Name

Type

Description

dealer_id

string

Required.

JSON parameters

Name

Type

Description

comment

string

User email.

status

string

User status. One of 'active', 'blocked'.

name

string

Required. User name.

email_notify

boolean

Send email with access data for new user. Default: False

access

string

User access type. One of 'full', 'read_only'.

extra_params

string

User extra params.

timezone

string

User timezone.

login

string

Required. User login.

password

string

Required. User password.

email_for_notify

string

User email.

email

string

Required. User email.

Resource fields

Name

Type

Description

comment

string

status

string

dealer_id

integer

name

string

email

string

access

string

extra_params

string

timezone

string

login

string

id

integer

Resource id.

GET /dealer/{dealer_id}/user/dealer/

Get user dealer list

Path parameters

Name

Type

Description

dealer_id

string

Required.

...

Name

Type

Description

id

array [integer]

login

array [string]

Resource fields

Name

Type

Description

comment

string

status

string

dealer_id

integer

name

string

email

string

access

string

extra_params

string

timezone

string

login

string

id

integer

Resource id.

...

PUT /dealer/{dealer_id}/user/dealer/{user_id}

Update user dealer

Path parameters

Name

Type

Description

dealer_id

string

Required.

user_id

integer

Required.

JSON parameters

Name

Type

Description

comment

string

User email.

status

string

User status. One of 'active', 'blocked'.

name

string

User name.

access

string

User access type. One of 'full', 'read_only'.

extra_params

string

User extra params.

timezone

string

User timezone.

password

string

User password.

email

string

User email.

Resource fields

Name

Type

Description

comment

string

status

string

dealer_id

integer

name

string

email

string

access

string

extra_params

string

timezone

string

login

string

id

integer

Resource id.

GET /dealer/{dealer_id}/user/dealer/{user_id}

Get user dealer

Path parameters

Name

Type

Description

dealer_id

string

Required.

user_id

integer

Required.

Resource fields

Name

Type

Description

comment

string

status

string

dealer_id

integer

name

string

email

string

access

string

extra_params

string

timezone

string

login

string

id

integer

Resource id.

DELETE /dealer/{dealer_id}/user/dealer/{user_id}

Delete user dealer

Path parameters

Name

Type

Description

dealer_id

string

Required.

user_id

integer

Required.

...