Calls

Resolve Shortcode

Changed on

Resolve a shortcode to the record it points at.

A shortcode targets a call, a chat conversation or an intake form session. This endpoint is public (no authentication required) as it's accessed from SMS links before the user is logged in; it returns only an opaque ID, and the detail page it resolves to stays auth-guarded.

Returns:

  • target_type: 'call', 'chat' or 'form'
  • target_id: The UUID of that record
  • call_id: Deprecated; same as target_id for 'call' targets
get/calls/shortcode/{shortcode}

Request

  • Base URL: https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.openintake.ai/calls/shortcode/{shortcode}
  • Auth: none declared

Path parameters

shortcodestring required

Response

Successful Response

target_type'call' | 'chat' | 'form' required

What kind of record a shortcode points at.

target_idstring uuid required

The ID of the call, chat conversation or form session

call_idstring uuid nullable

Deprecated: same as target_id when target_type is 'call'

Changes

  • 0afcd7c31ce2Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      response property call_id list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status