Skip to content

Update existing SIP endpoint

Request

Updated an existing SIP endpoint by specifying its ID.

Security
Basic or OAuth2.0
Path
projectIdstringrequired

The projectId is a required parameter you must include when making any API calls. You can find your project ID on your Build dashboard.

Example:3acb7ae1-cf3d-4112-ba5e-3a9d8c71cd47
sipTrunkIdstringrequired

The ID of the SIP trunk.

sipEndpointIdinteger, (int64), >= 0required

The ID of the SIP endpoint.

Bodyapplication/json
One of:

A SIP endpoint which is the address of your SIP infrastructure. SIP endpoints can be one of two types: static endpoints or registered endpoints.

EndpointDescription
Static endpointsStatic endpoints are defined by a static value which can either be an IP address or a domain name.
Registered endpointsRegistered endpoints use a credential list to determine the endpoint.

namestringrequired

The friendly name of the SIP endpoint.

Example:"Acme Endpoint"
priorityinteger, (int32), >= 1required

Inbound call routing priority. If two or more endpoints have the same priority, calls will be routed to them using a round-robin strategy.

Lower priority endpoints will be routed to first. Equal priority endpoints will round-robin calls between them.

Example:1
transportstring

The transport protocol of the SIP endpoint.

Default:"UDP"
Example:"UDP"
enabledboolean

Sets whether the SIP endpoint is enabled or not.

Default:true
addressstringrequired

The address of the SIP endpoint can be an IP address or a domain name. EST uses IP authentication and will only accept calls from the specified address or domain.

Example:"127.0.0.1"
portinteger, (int32), [ 1 .. 65535 ]

The port of the SIP endpoint.

Default:5060
Example:5060
curl -i -X PUT \
  -u '<username>:<password>' \
  'https://elastic-trunking.api.sinch.com/v1/projects/3acb7ae1-cf3d-4112-ba5e-3a9d8c71cd47/trunks/{sipTrunkId}/endpoints/{sipEndpointId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": "127.0.0.1",
    "port": 5060,
    "name": "Acme Endpoint",
    "transport": "UDP",
    "priority": 1,
    "enabled": true
  }'

Responses

A successful response.

Bodyapplication/json
One of:

A SIP endpoint which is the address of your SIP infrastructure. SIP endpoints can be one of two types: static endpoints or registered endpoints.

EndpointDescription
Static endpointsStatic endpoints are defined by a static value which can either be an IP address or a domain name.
Registered endpointsRegistered endpoints use a credential list to determine the endpoint.

namestringrequired

The friendly name of the SIP endpoint.

Example:"Acme Endpoint"
priorityinteger, (int32), >= 1required

Inbound call routing priority. If two or more endpoints have the same priority, calls will be routed to them using a round-robin strategy.

Lower priority endpoints will be routed to first. Equal priority endpoints will round-robin calls between them.

Example:1
idstringread-only

The ID of the SIP endpoint.

sipTrunkIdstringread-only

The ID of the SIP trunk to which the endpoint is assigned.

Example:"bbc55c4c-fe25-11ec-8482-d2e74e85a66f"
transportstring

The transport protocol of the SIP endpoint.

Default:"UDP"
Example:"UDP"
enabledboolean

Sets whether the SIP endpoint is enabled or not.

Default:true
createTimestring, (date-time)read-only

The date and time that the SIP endpoint was created.

Example:"2022-01-01T00:00:00Z"
updateTimestring, (date-time)read-only

The date and time that the SIP endpoint was last modified.

Example:"2022-01-01T00:00:00Z"
addressstringrequired

The address of the SIP endpoint can be an IP address or a domain name. EST uses IP authentication and will only accept calls from the specified address or domain.

Example:"127.0.0.1"
portinteger, (int32), [ 1 .. 65535 ]

The port of the SIP endpoint.

Default:5060
Example:5060
Response
{ "address": "127.0.0.1", "port": 5060 }
We'd love to hear from you!
Rate this content: