COconnexcs
SIP User

Update

Changed on

Update an existing SIP User record by ID.

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

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

Path parameters

idinteger required

Id identifier

Request body

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 required

Strip

statusinteger required

Status

rewriteobject

Rewrite

voicemailinteger required

Voicemail

voicemail_passwordstring password required

Voicemail Password

ip_whiteliststring

Ip Whitelist

emailstring email

Email

sip_pinginteger required

Sip Ping

smartinteger required

Smart

retain_didinteger required

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 request

{
  "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"
}

Response

Operation completed successfully

statusstring

Operation status

Example response

{
  "status": "OK"
}

Changes

  • fa097c4785b8Revision changes
    • info

      the endpoint scheme security oAuth2 was added to the API

    • info

      the endpoint scheme security opaqueToken was added to the API

    • info

      the endpoint scheme security basicAuth was removed from the API