latestOpenAPI 3.0.3MIT2026-08-124627160.3 KB

c04c2c708bf9

SIP Trunks

Update SIP trunk

Update an existing SIP Trunk by ID. The whole object must be sent. Any missing fields will be set to null.

put/trunks/{sipTrunkId}

Path parameters

sipTrunkIdstring required

The ID of the SIP trunk.

Request body

idstring

The SIP trunk id.

hostNamestring required

The host of the domain you would like to have for you trunk.

topLevelDomainstring

The top level domain to which the SIP trunk belongs.

domainstring

The fully qualified name of the domain, which is a combination of your 'hostName' and the 'topLevelDomain'.

namestring required

The friendly name of your SIP trunk.

callsPerSecondinteger

Number of calls started per second, to increase this please contact your account manager.

enableCallerNameboolean

Enable caller name lookup for incoming calls. US and canada only.

callForwardNumberstring

The valid E.164 phone number that will be dialed on inbound calls when no SIP endpoints are available. Required if enableCallForward property is true.

enableCallForwardboolean

When enabled, if an inbound call can not be delivered to a SIP endpoint, calls will be forwarded to the configured callForwardNumber. To forward all calls without trying SIP, simply disable (or delete) all SIP endpoints on this trunk. Logs (and billing) will be created for 2 calls (inbound and outbound). Note: Since there is no SIP connection, PCAPs will not be generated.

createTimestring date-time

The date and time that the SIP trunk was created.

updateTimestring date-time

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

projectIdstring

The ID of the account.

Example request

{
  "hostName": "acme-domain-1",
  "topLevelDomain": ".elastic-sip.sinch.com",
  "domain": "acme-domain-1.elastic-sip.sinch.com",
  "name": "Acme Trunk",
  "callsPerSecond": 100,
  "enableCallerName": true,
  "callForwardNumber": "+17208511190",
  "enableCallForward": true,
  "createTime": "2022-01-01T00:00:00Z",
  "updateTime": "2022-01-01T00:00:00Z",
  "projectId": "1bf62742-7b84-4666-9cbe-8e5734fd57d0"
}

Response

SIP trunk updated successfully

idstring

The SIP trunk id.

hostNamestring required

The host of the domain you would like to have for you trunk.

topLevelDomainstring

The top level domain to which the SIP trunk belongs.

domainstring

The fully qualified name of the domain, which is a combination of your 'hostName' and the 'topLevelDomain'.

namestring required

The friendly name of your SIP trunk.

callsPerSecondinteger

Number of calls started per second, to increase this please contact your account manager.

enableCallerNameboolean

Enable caller name lookup for incoming calls. US and canada only.

callForwardNumberstring

The valid E.164 phone number that will be dialed on inbound calls when no SIP endpoints are available. Required if enableCallForward property is true.

enableCallForwardboolean

When enabled, if an inbound call can not be delivered to a SIP endpoint, calls will be forwarded to the configured callForwardNumber. To forward all calls without trying SIP, simply disable (or delete) all SIP endpoints on this trunk. Logs (and billing) will be created for 2 calls (inbound and outbound). Note: Since there is no SIP connection, PCAPs will not be generated.

createTimestring date-time

The date and time that the SIP trunk was created.

updateTimestring date-time

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

projectIdstring

The ID of the account.

Example response

{
  "hostName": "acme-domain-1",
  "topLevelDomain": ".elastic-sip.sinch.com",
  "domain": "acme-domain-1.elastic-sip.sinch.com",
  "name": "Acme Trunk",
  "callsPerSecond": 100,
  "enableCallerName": true,
  "callForwardNumber": "+17208511190",
  "enableCallForward": true,
  "createTime": "2022-01-01T00:00:00Z",
  "updateTime": "2022-01-01T00:00:00Z",
  "projectId": "1bf62742-7b84-4666-9cbe-8e5734fd57d0"
}