Retrieve forwarding instructions
For a business with a plain mobile line and no SIP trunk: the Jelliu number to forward to and the GSM codes to dial, so calls to the business’s own number land on this number and the bound agent answers. Forwarding itself is configured on the customer’s carrier; Jelliu cannot see whether it is active.
Refused (400) when the number is a WhatsApp-only line, has no agent bound (a forward into nothing rings into nothing), or is inactive. Outbound calls still show the Jelliu number as caller ID; to call from the business’s own number use POST /api/phone-numbers/connect-sip.
notes are written in Spanish when Accept-Language starts with es, in English otherwise. Codes and shape are identical in both.
Idempotency. Read-only; safe to retry.
Access
- Required scope:
read(orwrite). - Rate limit: General API — per plan: 120 to 600 requests/min per workspace. See Rate limits.
- Plan: Available on every plan.
Authentication
Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the
dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once,
at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.
Operations restricted to admins or owners reject keys without the full scope with 403, and say so in
their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret —
that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds.
See Authentication.
Path parameters
The phone number’s id (not the E.164 number). Must be a UUID (400 otherwise).
Headers
Language of notes: any value starting with es gives Spanish; anything else, or no header, gives English.
Response
How to forward a plain mobile line to a Jelliu number. Returned by GET /api/phone-numbers/{id}/forwarding-instructions.