Sign in
SIP User

Read

Retrieve a single SIP User record by ID.

get/api/cp/switch/user/{id}

Path parameters

idinteger required

Id identifier

Response

Successful response

idinteger

Id

company_idinteger

Company Id (references company.id)

usernamestring

Username

passwordstring password

Password

bandwidthinteger

Bandwidth

channelsinteger

Channels

cpsinteger

Cps

protocolstring

Protocol

codecstring

Codec

dial_patternstring

Dial Pattern

prefixstring

Prefix

cli_prefixstring

Cli Prefix

stripinteger

Strip

statusinteger

Status

rewriteobject

Rewrite

voicemailinteger

Voicemail

voicemail_passwordstring password

Voicemail Password

ip_whiteliststring

Ip Whitelist

emailstring email

Email

sip_pinginteger

Sip Ping

smartinteger

Smart

retain_didinteger

Retain Did

sip_profile_idinteger

Sip Profile Id

address_numberstring

Address Number

street_namestring

Street Name

citystring

City

statestring

State

post_codestring

Post Code

Example response

{
  "id": 12345,
  "company_id": 1,
  "username": "john_doe",
  "password": "********",
  "bandwidth": 123,
  "channels": 123,
  "cps": 123,
  "protocol": "example_protocol",
  "codec": "example_codec",
  "dial_pattern": "example_dial_pattern",
  "prefix": "example_prefix",
  "cli_prefix": "example_cli_prefix",
  "strip": 123,
  "status": "Active",
  "rewrite": "example_rewrite",
  "voicemail": 1,
  "voicemail_password": "example_voicemail_password",
  "ip_whitelist": "example_ip_whitelist",
  "email": "user@example.com",
  "sip_ping": 1,
  "smart": 1,
  "retain_did": 1,
  "sip_profile_id": 1,
  "address_number": "example_address_number",
  "street_name": "example_street_name",
  "city": "example_city",
  "state": "example_state",
  "post_code": "example_post_code"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.