EZ Texting Messages API

openapi: 3.2.0
info:
  title: EzTexting Messages API
  description: EzTexting API
  termsOfService: https://www.eztexting.com/terms
  contact:
    email: support@eztexting.com
  version: '1.0'
servers:
- url: a.eztexting.com
security:
- basic_auth:
  - read
  - write
- oauth_auth:
  - read
  - write
tags:
- name: Messages
paths:
  /v1/campaign-info:
    get:
      tags:
      - Messages
      summary: List Campaigns Info
      description: List all campaign info matching provided filters
      operationId: listCampaigns
      parameters:
      - name: page
        in: query
        description: Offset of a given page. The default is 0. See [pagination](https://eztexting.readme.io/docs/pagination) docs for more information.
        required: false
        schema:
          type: integer
          default: 0
        example: 0
      - name: size
        in: query
        description: The maximum number of records to return in a paged list response. The default is 20 and allowed values are 10, 20, 50, 100, 200
        required: false
        schema:
          type: string
        example: 20
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
        required: false
        schema:
          type: array
          items:
            type: string
      - name: filters[sentAt][gte]
        in: query
        description: 'Filter by sentAt after - example: 2020-01-03T10:15:30+00:00'
        schema:
          type: string
      - name: filters[sentAt][lte]
        in: query
        description: 'Filter by sentAt before - example: 2020-01-04T10:15:30+00:00'
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PageResponseCampaignInfo'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
  /v1/message-details/{id}:
    get:
      tags:
      - Messages
      summary: Get Message Details
      description: Get details about a message
      operationId: details
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MessageDetails'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
  /v1/messages:
    get:
      tags:
      - Messages
      summary: List Messages
      description: List all messages matching provided filters
      operationId: list_6
      parameters:
      - name: page
        in: query
        description: Offset of a given page. The default is 0. See [pagination](https://eztexting.readme.io/docs/pagination) docs for more information.
        required: false
        schema:
          type: integer
          default: 0
        example: 0
      - name: size
        in: query
        description: The maximum number of records to return in a paged list response. The default is 20 and allowed values are 10, 20, 50, 100, 200
        required: false
        schema:
          type: string
          default: '20'
          enum:
          - '10'
          - '20'
          - '50'
          - '100'
          - '200'
        example: 20
      - name: sort
        in: query
        description: 'Sort field name and direction (asc or desc).  Example: sort=created,desc'
        required: false
        schema:
          type: string
      - name: filters[userNumber][eq]
        in: query
        description: Filter by your sending number
        schema:
          type: string
      - name: filters[contactNumber][eq]
        in: query
        description: Filter by contact phone number
        schema:
          type: string
      - name: filters[messageId][eq]
        in: query
        description: Filter by message id
        schema:
          type: string
      - name: filters[unread][eq]
        in: query
        description: 'Filter by unread flag: true for unread, false for read'
        schema:
          type: string
      - name: filters[deleted][eq]
        in: query
        description: 'Include deleted messages: true'
        schema:
          type: string
      - name: filters[pending][eq]
        in: query
        description: 'Include pending (not sent yet) messages: true'
        schema:
          type: string
      - name: filters[incoming][eq]
        in: query
        description: 'Filter by incoming flag: true for incoming, false for outgoing'
        schema:
          type: string
      - name: filters[textQuery][eq]
        in: query
        description: Filter by a message text query
        schema:
          type: string
      - name: filters[group][eq]
        in: query
        description: 'Filter by group flag: true for group, false for 1-1 chat'
        schema:
          type: string
      - name: filters[type][eq]
        in: query
        description: 'Filter by type: sms, mms'
        schema:
          type: string
      - name: filters[optType][eq]
        in: query
        description: Filter by opt type. Can be optOut or optIn, none (if none of the previous has to be searched)
        schema:
          type: string
      - name: filters[sentAt][gte]
        in: query
        description: 'Filter by sentAt after - example: 2020-01-03T10:15:30+00:00'
        schema:
          type: string
      - name: filters[sentAt][lte]
        in: query
        description: 'Filter by sentAt before - example: 2020-01-04T10:15:30+00:00'
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PageResponseMessage'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
    post:
      tags:
      - Messages
      summary: Create Message
      description: Create a message, send it either now or in the future
      operationId: create_3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageCreateRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/IdResponseString'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
    delete:
      tags:
      - Messages
      summary: Delete Messages
      description: Delete messages by list of ids
      operationId: delete_4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteMessagesRequest'
        required: true
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Errors'
components:
  schemas:
    DeleteMessagesRequest:
      type: object
      properties:
        ids:
          type: array
          description: Collection of message ids to remove
          items:
            type: integer
            format: int64
          minItems: 1
      required:
      - ids
    MessageDetails:
      type: object
      description: Message
      properties:
        groups:
          type: array
          description: Groups this message was sent to
          items:
            $ref: '#/components/schemas/ContactGroup'
        contacts:
          type: array
          description: Individual contacts this message was sent to (not in Groups)
          items:
            $ref: '#/components/schemas/Contact'
        recipientsCount:
          type: integer
          format: int32
          description: Number of recipients for this message
        credits:
          type: integer
          format: int32
          description: Number of credits used to send this message
        fromNumber:
          type: string
          description: Number this message was sent from
        sentOn:
          type: string
          format: date-time
          description: The date this message was sent
        type:
          type: string
          description: 'Requested message type: SMS or MMS'
          enum:
          - SMS
          - MMS
    Error:
      type: object
      properties:
        code:
          type: string
        title:
          type: string
        message:
          type: string
    PageResponseCampaignInfo:
      type: object
      description: Page
      properties:
        content:
          type: array
          description: The paged collection of elements
          items:
            $ref: '#/components/schemas/CampaignInfo'
        number:
          type: integer
          format: int32
          description: The requested page number
          example: 0
        size:
          type: integer
          format: int32
          description: The requested page size
          example: 20
        totalElements:
          type: integer
          format: int64
          description: The total number of elements available
          example: 100
        totalPages:
          type: integer
          format: int32
          description: The total number of pages available
          example: 5
        numberOfElements:
          type: integer
          format: int32
          description: The number of elements in the current page
          example: 20
    Contact:
      type: object
      description: Contact
      properties:
        phoneNumber:
          type: string
          description: Phone number
        firstName:
          type: string
          description: First name
        lastName:
          type: string
          description: Last name
        email:
          type: string
          description: Email address
        note:
          type: string
          description: Notes
        custom1:
          type: string
          description: Custom value 1
        custom2:
          type: string
          description: Custom value 2
        custom3:
          type: string
          description: Custom value 3
        custom4:
          type: string
          description: Custom value 4
        custom5:
          type: string
          description: Custom value 5
        source:
          type: integer
          format: int32
          description: Source this contact was created from, e.g. API, WEBWIDGET, UPLOAD etc
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 10
          - 11
          - 12
          - 13
          - 14
          - 15
          - 16
          - 17
          - 18
          - 19
          - 21
          - 22
          - 23
          - 999990
          - 999991
          - 999992
          - 999993
          - 999994
          - 999995
        values:
          type: object
          additionalProperties:
            type: string
        createdAt:
          type: string
          format: date-time
          description: Created date
        updatedAt:
          type: string
          format: date-time
          description: Last modification date
        optOut:
          type: boolean
          description: Is opted out
        groups:
          type: array
          description: Groups this contact is in
          items:
            $ref: '#/components/schemas/ContactGroup'
    IdResponseString:
      type: object
      properties:
        id:
          type: string
    PageResponseMessage:
      type: object
      description: Page
      properties:
        content:
          type: array
          description: The paged collection of elements
          items:
            $ref: '#/components/schemas/Message'
        number:
          type: integer
          format: int32
          description: The requested page number
          example: 0
        size:
          type: integer
          format: int32
          description: The requested page size
          example: 20
        totalElements:
          type: integer
          format: int64
          description: The total number of elements available
          example: 100
        totalPages:
          type: integer
          format: int32
          description: The total number of pages available
          example: 5
        numberOfElements:
          type: integer
          format: int32
          description: The number of elements in the current page
          example: 20
    MessageCreateRequest:
      type: object
      properties:
        message:
          type: string
          description: The text message to send
          example: Example Message
        companyName:
          type: string
          description: Company name, if provided will be added as message prefix
        sendAt:
          type: string
          format: date-time
          description: 'When to send the message (omit to send immediately) example: 2020-12-03T10:15:30+00:00'
        mediaFileId:
          type: string
          description: Media file id - reference to a previously uploaded media file
        mediaUrl:
          type: string
          description: Media url - most standard format image, video and audio files supported up to 5MB
        messageTemplateId:
          type: string
          description: Message template id to build message from
        fromNumber:
          type: string
          description: Number to send from - only required if you have more than one number available to send from
        toNumbers:
          type: array
          description: Collection of contact numbers to send to
          items:
            type: string
        groupIds:
          type: array
          description: Collection of contact group ids to send to
          items:
            type: string
        strictValidation:
          type: boolean
          description: If false - message will be sent to all valid numbers (all invalid numbers will be skipped),if true - message will not be sent if there is at least one invalid number from list
        messageType:
          type: string
          description: Requested message type to send
          enum:
          - SMS
          - MMS
    ContactGroup:
      type: object
      description: ContactGroup
      properties:
        id:
          type: string
          description: Group id
        name:
          type: string
          description: Group name
        note:
          type: string
          description: Notes related to contact group
        contactsCount:
          type: integer
          format: int32
          description: Number of contacts in contact group
    CampaignInfo:
      type: object
      description: Campaign Info
      properties:
        id:
          type: integer
          format: int64
          description: Campaign id
    Message:
      type: object
      description: Message
      properties:
        id:
          type: string
          description: Message id
        userNumber:
          type: string
          description: User sending number
        contactNumber:
          type: string
          description: Contact phone number
        inbound:
          type: boolean
          description: Inbound message flag
        message:
          type: string
          description: Message text
        mediaUrl:
          type: string
          description: Media url
        sentAt:
          type: string
          format: date-time
          description: Sent at timestamp
        optIn:
          type: boolean
          description: Opt-in flag
        optOut:
          type: boolean
          description: Op-out flag
        status:
          type: string
          description: 'Message status: READ, UNREAD, DELETED'
          enum:
          - READ
          - UNREAD
          - PENDING
          - DELETED
        type:
          type: string
          description: 'Message type: SMS or MMS'
          enum:
          - SMS
          - MMS
        group:
          type: boolean
          description: Group message flag
        messageGroupId:
          type: string
          description: Message group id
    Errors:
      type: object
      properties:
        status:
          type: integer
          format: int32
        title:
          type: string
        detail:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basic_auth:
      type: http
      scheme: basic
    oauth_auth:
      type: oauth2
      flows:
        password:
          tokenUrl: http://nova-app.stg0.cf.wtf/oauth_token/generate/swagger
          scopes:
            read: ''
            write: ''
x-proxy-enabled: false
x-send-defaults: true
x-samples-languages:
- curl
- node
- ruby
- javascript
- python
- java
- swift
- kotlin
- go
- csharp
x-provenance:
  method: searched
  source: https://developers.eztexting.com/reference
  harvested: '2026-11-07'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.eztexting.com/reference/acquire-1.md
  - https://developers.eztexting.com/reference/acquire_1-1.md
  - https://developers.eztexting.com/reference/archive-1.md
  - https://developers.eztexting.com/reference/blockoutboundtexts-1.md
  - https://developers.eztexting.com/reference/check-1.md
  - https://developers.eztexting.com/reference/contactsadd-1.md
  - https://developers.eztexting.com/reference/contactsremove-1.md
  - https://developers.eztexting.com/reference/create-1.md
  - https://developers.eztexting.com/reference/create_1-1.md
  - https://developers.eztexting.com/reference/create_2-1.md
  - https://developers.eztexting.com/reference/create_3-1.md
  - https://developers.eztexting.com/reference/create_4-1.md
  - https://developers.eztexting.com/reference/create_5-1.md
  - https://developers.eztexting.com/reference/create_6-1.md
  - https://developers.eztexting.com/reference/createorupdate-1.md
  - https://developers.eztexting.com/reference/createorupdatebatch-1.md
  - https://developers.eztexting.com/reference/creditbalance-1.md
  - https://developers.eztexting.com/reference/delete-1.md
  - https://developers.eztexting.com/reference/delete_1-1.md
  - https://developers.eztexting.com/reference/delete_2-1.md
  - https://developers.eztexting.com/reference/delete_3-1.md
  - https://developers.eztexting.com/reference/delete_4-1.md
  - https://developers.eztexting.com/reference/delete_5-1.md
  - https://developers.eztexting.com/reference/delete_6-1.md
  - https://developers.eztexting.com/reference/details-1.md
  - https://developers.eztexting.com/reference/get-1.md
  - https://developers.eztexting.com/reference/get_1-1.md
  - https://developers.eztexting.com/reference/get_2-1.md
  - https://developers.eztexting.com/reference/get_3-1.md
  - https://developers.eztexting.com/reference/get_4-1.md
  - https://developers.eztexting.com/reference/get_5-1.md
  - https://developers.eztexting.com/reference/get_6-1.md
  - https://developers.eztexting.com/reference/list-1.md
  - https://developers.eztexting.com/reference/list_1-1.md
  - https://developers.eztexting.com/reference/list_2-1.md
  - https://developers.eztexting.com/reference/list_3-1.md
  - https://developers.eztexting.com/reference/list_4-1.md
  - https://developers.eztexting.com/reference/list_5-1.md
  - https://developers.eztexting.com/reference/list_6-1.md
  - https://developers.eztexting.com/reference/list_7-1.md
  - https://developers.eztexting.com/reference/list_8-1.md
  - https://developers.eztexting.com/reference/listcampaigns-1.md
  - https://developers.eztexting.com/reference/listresponsesdelivery-1.md
  - https://developers.eztexting.com/reference/listresponsesengagement-1.md
  - https://developers.eztexting.com/reference/listresponseslink-1.md
  - https://developers.eztexting.com/reference/messagelist-1.md
  - https://developers.eztexting.com/reference/messageread-1.md
  - https://developers.eztexting.com/reference/messageunread-1.md
  - https://developers.eztexting.com/reference/purchasecredits-1.md
  - https://developers.eztexting.com/reference/refresh-1.md
  - https://developers.eztexting.com/reference/release-1.md
  - https://developers.eztexting.com/reference/restore-1.md
  - https://developers.eztexting.com/reference/revoke-1.md
  - https://developers.eztexting.com/reference/update-1.md
  - https://developers.eztexting.com/reference/update_1-1.md
  - https://developers.eztexting.com/reference/update_2-1.md
  - https://developers.eztexting.com/reference/updatesettings-1.md
  merge:
    pages: 57
    deduped: 253
    conflicts_kept_first: 0