Skip to content

ExoVoIPDeveloper guide

Mobile forwarding

Calls to an extension can also reach the user's mobile phone. Scopes extensions:read / extensions:write.

Forwarding and forwarding mode

Forwarding to mobile (PUT /v1/extensions/:id/follow-me): number, rings before forwarding, mode (simultaneous or sequential).
Forwarding mode (PUT /v1/extensions/:id/invisible-forwarding): how the call is presented on the mobile phone.

curl -s -X PUT https://centralino.exovoip.it/api/v1/extensions/12/follow-me \
  -H "X-API-Key: $EXOPBX_API_KEY" -H "Content-Type: application/json" \
  -d '{"enabled":true,"number":"+393331234567","rings":3}'
curl -s -X PUT https://centralino.exovoip.it/api/v1/extensions/12/invisible-forwarding \
  -H "X-API-Key: $EXOPBX_API_KEY" -H "Content-Type: application/json" \
  -d '{"style":"whisper","whisperText":"Chiamata dal centralino"}'

await pbx.extensions.followMe(12, { enabled: true, number: '+393331234567', rings: 3 });
await pbx.forwarding.update(12, { style: 'whisper', whisperText: 'Chiamata dal centralino' });
const current = await pbx.forwarding.get(12);

$pbx->extensions->followMe(12, ['enabled' => true, 'number' => '+393331234567', 'rings' => 3]);
$pbx->forwarding->update(12, ['style' => 'whisper', 'whisperText' => 'Chiamata dal centralino']);

pbx.extensions.follow_me(12, {"enabled": True, "number": "+393331234567", "rings": 3})
pbx.forwarding.update(12, {"style": "whisper", "whisperText": "Chiamata dal centralino"})

`style`	Behavior
`confirm`	Default. The user hears a prompt and presses a key to accept, so a call that ends up in the mobile phone's voicemail is not treated as answered
`silent`	The call is connected as soon as the mobile phone answers; `silentTimeoutS` is the ring time to the mobile phone
`whisper`	Before connecting, the user hears a short announcement (`whisperText`, where `{caller}` is the phonebook name or the number, or `whisperPromptId`)

External numbers must comply with the tenant's allowed-destinations policy (see Outbound routes).

Carrier-side forwarding (platform)

GET/PUT /v1/extensions/:id/provider-divert manages forwarding configured directly with the telephone carrier: reserved for global keys.

Endpoints

Request	Scope	SDK method
`GET /v1/extensions/:id/invisible-forwarding`	`extensions:read`	`forwarding.get()`
`PUT /v1/extensions/:id/invisible-forwarding`	`extensions:write`	`forwarding.update()`
`GET /v1/extensions/:id/provider-divert`	`tenants:write`	`forwarding.getProviderDivert() · py: forwarding.get_provider_divert()`
`PUT /v1/extensions/:id/provider-divert`	`tenants:write`	`forwarding.setProviderDivert() · py: forwarding.set_provider_divert()`