Retrieve forwarding instructions

{
  "data": {
    "forwardTo": "+13055550142",
    "agentName": "Sofía - Agendamiento",
    "codes": {
      "activateAll": "**21*+13055550142#",
      "activateWhenBusy": "**67*+13055550142#",
      "activateWhenUnanswered": "**61*+13055550142#",
      "activateWhenUnreachable": "**62*+13055550142#",
      "deactivateAll": "##002#",
      "check": "*#21#"
    },
    "notes": [
      "Marca el código desde el teléfono donde está la línea y pulsa llamar. La operadora confirma en pantalla.",
      "Desde ese momento, toda llamada a tu número cae en +13055550142, donde contesta Sofía - Agendamiento. Tus clientes siguen marcando el número de siempre.",
      "El desvío es un servicio de TU operadora: algunas bloquean el desvío a un número extranjero, y el tramo desviado lo factura ella a su tarifa. Si rechaza el código, consúltalo con la operadora.",
      "Esto cubre las llamadas ENTRANTES. Las que haga el agente siguen mostrando el número de Jelliu como identificador; para que salga tu número al llamar hace falta una troncal SIP (Conectar mi número) o portar el número.",
      "Las líneas fijas y las centralitas tienen sus propios menús de desvío: los códigos de arriba son para líneas móviles."
    ]
  }
}

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 (or write).
Rate limit: General API — per plan: 120 to 600 requests/min per workspace. See Rate limits.
Plan: Available on every plan.

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` (or `write`). - **Rate limit:** General API — per plan: 120 to 600 requests/min per workspace. See [Rate limits](/rate-limits). - **Plan:** Available on every plan.

Authentication

AuthorizationBearer

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.

Scope	GET / HEAD	POST / PUT / PATCH / DELETE	Admin-only routes
`read`	Yes	No	No
`write`	Yes	Yes	No
`full`	Yes	Yes	Yes

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.

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. | Scope | GET / HEAD | POST / PUT / PATCH / DELETE | Admin-only routes | | --- | --- | --- | --- | | `read` | Yes | No | No | | `write` | Yes | Yes | No | | `full` | Yes | Yes | Yes | 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](/authentication).

Path parameters

idstringRequiredformat: "uuid"

The phone number’s id (not the E.164 number). Must be a UUID (400 otherwise).

Response

Instructions.

dataobject

How to forward a plain mobile line to a Jelliu number. Returned by GET /api/phone-numbers/{id}/forwarding-instructions.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error