Carrier connections
A carrier connection carries calls between Signals and a carrier you already have a contract with. Create a connection, give it the peers outbound calls go to and the source networks and password that authenticate inbound calls, and disable or release it. See Bring your own carrier.
List the project's carrier connections
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List the project's carrier connections › Responses
Every connection of the project.
Create a carrier connection
Headers
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Create a carrier connection › Request Body
attempt_deadline_secondsHow long the whole attempt across every peer may take; more than the peer timeout.
directionfailover_sip_codesThe SIP codes, 400 to 699, that move a call to the next peer.
g729G.711 (PCMA and PCMU) is always offered; true also offers G.729.
generate_passwordtrue generates the connection's first password, which the 201 body carries once.
identity_policymedia_securitynamenumber_formatpeer_timeout_secondsHow long one peer has to answer before the call moves to the next peer.
privacy_passthroughstripLeading digits removed from the dialled number before it is sent to the carrier.
inbound_trunk_idThe trunk that rings this connection's numbers: a trunk of this project that takes
inbound calls. Required unless direction is outbound, where a trunk is refused.
subaccount_idtech_prefixOne to fifteen digits put before the dialled number sent to the carrier.
Create a carrier connection › Responses
The connection was created and carries the next call.
passwordRead a carrier connection of the project
path Parameters
connection_idConnection id
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Read a carrier connection of the project › Responses
The connection.
directionhosted_number_countNumbers in the connection's active hosted blocks.
idnamenumbers_routed_elsewhereNumbers of the active hosted blocks a route sends somewhere other than inbound_trunk.
peer_countEnabled peers.
project_idrevisionThe current revision, quoted as the ETag; a write sends it back in If-Match.
signaling_fqdnThe hostname the carrier sends calls to, and the realm of the next generated password. Null once the connection is released, so another can take the name.
statusstatus_sinceWhen the connection entered status, such as when it was last enabled.
subaccount_idas_ofattempt_deadline_secondsHow long the whole attempt across every peer may take.
How the carrier proves a call to us is its own: its source networks, its passwords or both.
failover_sip_codesThe SIP codes that move a call to the next peer.
g729G.711 (PCMA and PCMU) is always offered; true also offers G.729.
identity_policymedia_securitynumber_formatpeer_timeout_secondsHow long one peer has to answer before the call moves to the next peer.
privacy_passthroughstripLeading digits removed from the dialled number before it is sent to the carrier.
tech_prefixRelease a carrier connection with no hosted numbers
path Parameters
connection_idConnection id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Release a carrier connection with no hosted numbers › Request Body
confirm_nameRelease a carrier connection with no hosted numbers › Responses
The connection is released and carries no further call.
Replace a carrier connection's own settings
path Parameters
connection_idConnection id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Replace a carrier connection's own settings › Request Body
attempt_deadline_secondsHow long the whole attempt across every peer may take; more than the peer timeout.
directionfailover_sip_codesThe SIP codes, 400 to 699, that move a call to the next peer.
g729G.711 (PCMA and PCMU) is always offered; true also offers G.729.
identity_policymedia_securitynamenumber_formatpeer_timeout_secondsHow long one peer has to answer before the call moves to the next peer.
privacy_passthroughstripLeading digits removed from the dialled number before it is sent to the carrier.
inbound_trunk_idThe trunk that rings this connection's numbers: a trunk of this project that takes
inbound calls. Required unless direction is outbound, where a trunk is refused.
subaccount_idtech_prefixOne to fifteen digits put before the dialled number sent to the carrier.
Replace a carrier connection's own settings › Responses
The connection was saved and carries the next call.
directionhosted_number_countNumbers in the connection's active hosted blocks.
idnamenumbers_routed_elsewhereNumbers of the active hosted blocks a route sends somewhere other than inbound_trunk.
peer_countEnabled peers.
project_idrevisionThe current revision, quoted as the ETag; a write sends it back in If-Match.
signaling_fqdnThe hostname the carrier sends calls to, and the realm of the next generated password. Null once the connection is released, so another can take the name.
statusstatus_sinceWhen the connection entered status, such as when it was last enabled.
subaccount_idas_ofattempt_deadline_secondsHow long the whole attempt across every peer may take.
How the carrier proves a call to us is its own: its source networks, its passwords or both.
failover_sip_codesThe SIP codes that move a call to the next peer.
g729G.711 (PCMA and PCMU) is always offered; true also offers G.729.
identity_policymedia_securitynumber_formatpeer_timeout_secondsHow long one peer has to answer before the call moves to the next peer.
privacy_passthroughstripLeading digits removed from the dialled number before it is sent to the carrier.
tech_prefixDisable a carrier connection
path Parameters
connection_idConnection id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Disable a carrier connection › Responses
The connection is disabled from the next call.
directionhosted_number_countNumbers in the connection's active hosted blocks.
idnamenumbers_routed_elsewhereNumbers of the active hosted blocks a route sends somewhere other than inbound_trunk.
peer_countEnabled peers.
project_idrevisionThe current revision, quoted as the ETag; a write sends it back in If-Match.
signaling_fqdnThe hostname the carrier sends calls to, and the realm of the next generated password. Null once the connection is released, so another can take the name.
statusstatus_sinceWhen the connection entered status, such as when it was last enabled.
subaccount_idas_ofattempt_deadline_secondsHow long the whole attempt across every peer may take.
How the carrier proves a call to us is its own: its source networks, its passwords or both.
failover_sip_codesThe SIP codes that move a call to the next peer.
g729G.711 (PCMA and PCMU) is always offered; true also offers G.729.
identity_policymedia_securitynumber_formatpeer_timeout_secondsHow long one peer has to answer before the call moves to the next peer.
privacy_passthroughstripLeading digits removed from the dialled number before it is sent to the carrier.
tech_prefixEnable a carrier connection
path Parameters
connection_idConnection id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Enable a carrier connection › Responses
The connection is enabled and carries the next call.
directionhosted_number_countNumbers in the connection's active hosted blocks.
idnamenumbers_routed_elsewhereNumbers of the active hosted blocks a route sends somewhere other than inbound_trunk.
peer_countEnabled peers.
project_idrevisionThe current revision, quoted as the ETag; a write sends it back in If-Match.
signaling_fqdnThe hostname the carrier sends calls to, and the realm of the next generated password. Null once the connection is released, so another can take the name.
statusstatus_sinceWhen the connection entered status, such as when it was last enabled.
subaccount_idas_ofattempt_deadline_secondsHow long the whole attempt across every peer may take.
How the carrier proves a call to us is its own: its source networks, its passwords or both.
failover_sip_codesThe SIP codes that move a call to the next peer.
g729G.711 (PCMA and PCMU) is always offered; true also offers G.729.
identity_policymedia_securitynumber_formatpeer_timeout_secondsHow long one peer has to answer before the call moves to the next peer.
privacy_passthroughstripLeading digits removed from the dialled number before it is sent to the carrier.
tech_prefixGenerate a carrier connection's password
path Parameters
connection_idConnection id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Generate a carrier connection's password › Responses
The password was generated in the realm of the connection's hostname and is accepted from the next call. This body alone carries it; a replay answers password: null.
created_atidrealmusernamevalid_untilWhen a rotated password stops working; null on the current one.
passwordreplaced_valid_untilWhen the password this one replaced stops working; null on a create.
Revoke a carrier connection's password
path Parameters
connection_idConnection id
credential_idIngress credential id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Revoke a carrier connection's password › Responses
The password was revoked and is refused from the next call, with no grace.
Replace a carrier connection's current password
path Parameters
connection_idConnection id
credential_idIngress credential id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Replace a carrier connection's current password › Responses
A new username and password replace the current one from the next call; the replaced one keeps working until replaced_valid_until. This body alone carries the new password; a replay answers password: null.
created_atidrealmusernamevalid_untilWhen a rotated password stops working; null on the current one.
passwordreplaced_valid_untilWhen the password this one replaced stops working; null on a create.
Add a source network to a carrier connection
path Parameters
connection_idConnection id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Add a source network to a carrier connection › Request Body
cidrAdd a source network to a carrier connection › Responses
The source network was added and is accepted from the next call.
cidrenabledidRemove a source network from a carrier connection
path Parameters
connection_idConnection id
source_idIngress source id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Remove a source network from a carrier connection › Responses
The source network was removed and is refused from the next call.
Replace a source network of a carrier connection
path Parameters
connection_idConnection id
source_idIngress source id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Replace a source network of a carrier connection › Request Body
cidrenabledReplace a source network of a carrier connection › Responses
The source network was saved and applies from the next call.
cidrenabledidAdd a peer to a carrier connection
path Parameters
connection_idConnection id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Add a peer to a carrier connection › Request Body
hostportprioritytransportweightAdd a peer to a carrier connection › Responses
The peer was added and takes the next call.
enabledhostidportprioritytransportweightRemove a peer from a carrier connection
path Parameters
connection_idConnection id
peer_idPeer id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Remove a peer from a carrier connection › Responses
The peer was removed and takes no further call.
Replace a peer of a carrier connection
path Parameters
connection_idConnection id
peer_idPeer id
Headers
If-MatchThe quoted revision the caller last read, so a concurrent change answers 412.
Idempotency-KeyOne nonblank key of at most 128 characters; a retry with the same key repeats the outcome.
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Replace a peer of a carrier connection › Request Body
enabledhostportprioritytransportweightReplace a peer of a carrier connection › Responses
The peer was saved and applies from the next call.
enabledhostidportprioritytransportweight