Plug your SIP-enabled PBX or TAS into the call path
This API enables PBX/TAS (Private Branch Exchange/Telephony Application Server) providers to plug their (SIP-enabled) endpoint into the call path.
It enables a SIP integration between Working Group Two's core and a PBX/TAS for a given MSISDN.
Virtual SIP Registrations are used to alter default call behavior and involve PBX/TAS into the SIP signaling path. The registration created per single MSISDN linked to the OAuth 2.0 round trip.
This API requires that you use the OAuth 2.0 Authorization Code Flow flow as shown in our docs.
To access this API, your credentials must include
The API is implemented as a gRPC service described below.
There are two methods supported by this API:
To register a (PBX/TAS-bound) MSISDN with our core, use
The same method is used if you want to update an existing registration.
DeleteRegistration when an existing registration is no longer needed.
Both methods receive
RegistrationRequest and return
RegistrationRequestis a structure containing the URI of the endpoint you host + some additional details related to the connected MSISDN.
RegistrationResponseis a simple structure conveying the status of method invocation (success/error)
You may find the proto definition of the service + the definition of the messages exchanged here.
There are three types of registrations:
Fallback. It is the registration type that decides how the calls will be handled by our core.
If a registration of one of these types is registered on an MSISDN, all the SIP signalling from/to that MSISDN will be replicated to the endpoint specified in the registration.
Loop: leg 4 is created only after the call comes back as leg 3
Please note that PBX/TAS is not obliged to create leg 3 as it can answer or reject leg 2 directly.
Fork: legs 2 and 3 are created simultaneously.
Typically, you use
Fork/Loopto implement your logic during a call.
The core will action upon a
Fallback registration if and only if:
- somebody calls the related MSISDN
- the MSISDN is either busy or no answer detected within the timeout (30s)
In such case, the core will replicate the INVITE to the endpoint specified during the registration.
Typically, you use
Fallbackto implement the likes of voice mail, call forwarding etc.
The examples below demonstrate how to consume this API.
For Java example, click here.