Auth

Create a message sign-in URL

Creates a hosted sign-in, reconnect, or permission-review URL for a message-channel sender. If a messageLinePhone or agentPhone is supplied, it must be an active registered message line for the acting agent and channel. Code-bearing responses require verified provider-signed message sender proof; without it, the endpoint returns the plain sign-in.me handoff and creates no code.

post/v1/auth/sign-in/message-url

Request

  • Base URL: https://api.configure.dev
  • URL: https://api.configure.dev/v1/auth/sign-in/message-url
  • Auth: API key in header X-API-Key

Headers

X-Agentstring
Example:your-agent

Required when the API key's developer account owns more than one active agent.

Request body

reason'signin' | 'reconnect' | 'permissions'
channelstring required
messageSenderProofstring

Provider-signed evidence that the message sender/thread claim is authentic. A code-bearing URL is returned only when Configure can verify this value.

connectorsstring[]
displayNamestring
agentLogostring
theme'light' | 'dark'
messageLinePhonestring

Current provider-owned message line that users return to after hosted sign-in. Must already be registered for the acting agent and channel.

agentPhonestring

Alias for messageLinePhone. Prefer this when resolving the agent's current line from the messaging provider.

messageBodystring

Suggested SMS/iMessage body for returning to the agent.

messageCompleteUrlstring

Optional trusted completion endpoint called by hosted sign-in after approval.

journeyIdstring

Optional application journey identifier used to map hosted completion back to a message thread.

returnMode'message'
idempotencyKeystring

Example request

{
  "channel": "sms",
  "messageLinePhone": "+14155550123",
  "agentPhone": "+14155550123"
}

Response

Hosted message sign-in URL.

OR

Example response

{
  "url": "https://sign-in.me/your-agent/cfgmsg_example"
}

Changes

No recorded changes to this operation across all 1 revision of this API.