Read the status of a contact submitted by this API client
Uses the same workspace, client, flow and node as submission. Returns only this client’s contact state. Unknown IDs, another client’s contacts and records beyond retention return 404. A status of complete means the provider conversation ended, not that the business objective succeeded.
Authentication
AuthorizationBearer
Token for one deployed API client, configured in Project → Channels.
Path parameters
id
Query parameters
workspaceId
Workspace containing the deployed API client.
environment
Environment containing both the applied outbound schedule and API client, for example development or live.
integrationId
API client identifier from Channels.
flowId
nodeId
Response
Existing contact; not inserted again. The returned status describes the existing request.
id
status
Current queue state, for example pending, invalid, ready, claimed, dialing, active, accepted, complete, rejected or uncertain. This is delivery state, not call outcome.
created
scheduledAt
Stored not-before time when the contact is still pending.
kind
Allowed values:
deferredReason
Why an immediate attempt could not claim the contact. The contact remains stored. Retry the same id with runNow to attempt it again; a paused schedule does not automatically retry.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
503
Service Unavailable Error