INinkbox
Contact Rules

List Org Phone Contact Rules

Changed on
get/api/v1/phone/contact-rules

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/phone/contact-rules
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

agent_identity_idstring uuid nullable

Narrow to a single agent identity. Omit to list across every identity in the org.

action'allow' | 'block'

Filter by allow or block.

match_type'exact_number'

Filter by match type (only 'exact_number' in v1).

direction'inbound' | 'outbound' | 'both'

Filter by applicable direction; both selects only bidirectional rules.

limitinteger

Max rules to return.

offsetinteger

Number of rules to skip.

Response

Successful Response

idstring uuid required
agent_identity_idstring uuid required
direction'inbound' | 'outbound' | 'both'
action'allow' | 'block' required
match_type'exact_number' required
match_targetstring required
status'active' | 'paused' | 'deleted' required
created_atstring date-time required
updated_atstring date-time required

Changes

  • 3e0d51f919a7Revision changes
    • info

      added the optional property /// to the response with the status

  • f3dcdb50fbaaRevision changes
    • info

      added the new optional query request parameter direction

    • info

      added the optional property / to the response with the status