Create a forwarding
Creates a new forwarding target inside a forwardings-type group. The
referenced group_id must belong to your organization and have
type: forwardings. When destination_type is sip, sip_uri is
required. When destination_type is sip_refer, sip_refer_target
is required. For a usable phone destination, provide a non-empty
phone_number; current request validation also accepts an omitted or
empty value, which produces a target that cannot be dialed.
bearerAuthAuthorizationBearer <token>API key in the Authorization: Bearer <key> header.
Keys are created in the Hallolara dashboard (Settings → API Keys).
application/json- body
When destination_type is sip, sip_uri must be provided. When
destination_type is sip_refer, sip_refer_target must be provided.
For a usable phone destination, provide a non-empty phone_number.
The current validator permits it to be omitted or empty, but such a
forwarding cannot be dialed.
group_id*string^[a-f0-9]{24}$type?string"personal""queue""fallback"destination_type?string"phone""phone""sip""sip_refer"gender?stringOptional gender value. Omit it or send an empty string when not specified.
job_title?stringfirst_name?stringlast_name?stringemail?stringcompetence?stringactivation_keywords?array<>items <= 50phone_number?stringsip_uri?stringSIP URI. Required when destination_type=sip.
^sip:sip_username?|Optional SIP auth username. Only allowed when destination_type=sip.
sip_password?|Optional SIP auth password. Only allowed when destination_type=sip; never returned in responses.
passwordsip_refer_target?stringSIP REFER target. Required when destination_type=sip_refer.
^\S+$1 <= lengthactive?booleanfallback?booleantimeout?integer10 <= value <= 60dtmf_sequence?array<>Created.
application/json- response
data?curl -X POST 'https://api.hallolara.ai/api/v1/forwardings' \ -H 'Content-Type: application/json' \ -d '{ "group_id": "65a1234567890abcdef01234", "type": "queue", "destination_type": "phone", "phone_number": "+12025550123"}'{ "data": { "id": "string", "group_id": "string", "group_name": "string", "type": "personal", "gender": "string", "job_title": "string", "first_name": "string", "last_name": "string", "email": "string", "competence": "string", "activation_keywords": [ "string" ], "destination_type": "phone", "phone_number": "string", "sip_uri": "string", "sip_username": "string", "sip_refer_target": "string", "has_sip_credentials": true, "identity_source": "employee", "active": true, "fallback": false, "timeout": 30, "dtmf_sequence": [ { "action": "pause", "duration": 0, "digits": "string" } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}