> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt
> Use this file to discover all available pages before exploring further.

# Handle Sinch SMS delivery receipt

> Status callback posted by Sinch for outbound SMS batches. Updates the matching Message documents with the latest delivery state (Delivered / Failed / Expired) and broadcasts a socket event so the org's connected clients see the new status.



## OpenAPI

````yaml /api-reference/openapi.yaml post /api/webhook/sinch/delivery-receipt
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/webhook/sinch/delivery-receipt:
    post:
      tags:
        - Webhooks
      summary: Handle Sinch SMS delivery receipt
      description: >-
        Status callback posted by Sinch for outbound SMS batches. Updates the
        matching Message documents with the latest delivery state (Delivered /
        Failed / Expired) and broadcasts a socket event so the org's connected
        clients see the new status.
      operationId: post_webhook_sinch_delivery_receipt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SinchDeliveryReceiptRequest'
      responses:
        '200':
          description: Receipt processed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SinchDeliveryReceiptAckResponse'
        '500':
          description: Receipt processing failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookErrorResponse'
components:
  schemas:
    SinchDeliveryReceiptRequest:
      type: object
      properties:
        batch_id:
          type: string
          description: >-
            Sinch batch identifier returned when the outbound SMS was submitted;
            used to locate the matching Message.
        statuses:
          description: >-
            One entry per delivery state in this batch; each contains the
            affected recipients and current status.
          type: array
          items:
            type: object
            properties:
              code:
                type: number
                description: Numeric Sinch delivery status code.
              status:
                type: string
                description: Status label, e.g. `Delivered`, `Failed`, `Expired`.
              count:
                type: number
                description: Number of recipients in this status bucket.
              recipients:
                type: array
                items:
                  type: string
                description: Recipient phone numbers this status applies to.
            additionalProperties: true
      additionalProperties: true
      example:
        batch_id: 01FC66621XXXXX119Z8PMV1QPQ
        statuses:
          - code: 0
            status: Delivered
            count: 1
            recipients:
              - '14165550100'
    SinchDeliveryReceiptAckResponse:
      type: object
      description: Ack returned after a Sinch SMS delivery receipt is consumed.
      properties:
        message:
          type: string
        batch_id:
          type: string
      required:
        - message
        - batch_id
      additionalProperties: true
      example:
        message: Delivery receipt received
        batch_id: 01K608PQBF3H41EQS64AH7CE11
    WebhookErrorResponse:
      type: object
      description: >-
        Error envelope used across provider webhook routes. Most failures only
        carry `error`; a few (ElevenLabs tool errors, ingress validation) add
        `success:false`, `message`, or a `code`. Many of these endpoints respond
        200 with `success:false` for recoverable cases (especially the
        ElevenLabs server tools) — only hard failures use 4xx/5xx.
      properties:
        error:
          type: string
        message:
          type: string
        success:
          type: boolean
          enum:
            - false
        code:
          type: string
        details:
          description: Optional diagnostic detail (stack snippet, validation issues, etc.).
      additionalProperties: true
      example:
        error: Webhook processing failed

````