Infobip
Infobip TikTok API

TikTok Business Messaging enables one-to-one conversations between TikTok users and your TikTok Business Account. With Infobip, you can receive inbound messages through webhooks, reply to users using the API, send events, and track delivery and seen status. — 4 operation path(s) and 3 webhook(s) in Infobip's published OpenAPI.
Documentation GitHub OpenAPI
OpenAPI Specification

{
 "openapi":"3.1.0",
 "info":{
  "title":"Infobip OpenAPI Specification",
  "description":"OpenAPI Specification that contains all public endpoints and webhooks.",
  "contact":{
   "name":"Infobip support",
   "email":"support@infobip.com"
  },
  "version":"3.210.0",
  "x-generatedAt":"2026-07-23T15:23:54.747544207Z"
 },
 "tags":[
  {
   "name":"channels",
   "description":"Create a perfect customer experience by using the channels your customer already use and love.\n",
   "x-type":"category",
   "x-displayName":"Channels"
  },
  {
   "name":"tiktok",
   "description":"TikTok Business Messaging enables one-to-one conversations between TikTok users and your TikTok Business Account. With Infobip, you can receive inbound messages through webhooks, reply to users using the API, send events, and track delivery and seen status.\n\n* **User-initiated only:** All conversations must be initiated by the TikTok user. You cannot send a message until the user has messaged your [Business Account](https://ads.tiktok.com/help/article/about-business-registration) first.\n* **Supported message types:** Text (up to 6,000 characters), image (JPG or PNG, max 3 MB), and share post. Outbound messages are valid for up to 48 hours. Messages not delivered within this window are not sent.\n* **Availability:** Not available for Business Accounts registered in the United States, European Economic Area (EEA), Switzerland, or the United Kingdom.\n\nBefore using this API, connect your TikTok Business Account to Infobip and [configure event subscriptions](https://www.infobip.com/docs/api/platform/subscriptions-api/subscription/create-subscription). See [Get started with TikTok](https://www.infobip.com/docs/tiktok/get-started) and [TikTok over API](https://www.infobip.com/docs/tiktok/api).\n\nTo use TikTok in combination with other channels, see [Messages API](https://www.infobip.com/docs/api/platform/messages-api).\n",
   "x-type":"product",
   "x-displayName":"TikTok"
  },
  {
   "name":"tiktok-outbound-messages",
   "description":"",
   "x-type":"section",
   "x-displayName":"Outbound message"
  },
  {
   "name":"tiktok-events",
   "description":"",
   "x-type":"section",
   "x-displayName":"Events"
  },
  {
   "name":"logs-and-status-reports-tiktok",
   "description":"",
   "x-type":"section",
   "x-displayName":"Logs and status reports"
  },
  {
   "name":"tiktok-inbound-messages",
   "description":"",
   "x-type":"section",
   "x-displayName":"Inbound message"
  }
 ],
 "paths":{
  "/tiktok/1/messages":{
   "post":{
    "tags":[
     "channels",
     "tiktok",
     "tiktok-outbound-messages"
    ],
    "summary":"Send TikTok messages",
    "description":"Send one or more text, image, or share-post messages to TikTok users in active conversations with your TikTok Business Account. You can send messages only after the user has messaged your Business Account first.",
    "externalDocs":{
     "description":"Learn more about the TikTok channel and its use cases",
     "url":"https://www.infobip.com/docs/tiktok"
    },
    "operationId":"send-tiktok-messages",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokRequest"
       },
       "examples":{
        "Image message":{
         "summary":"Image message",
         "value":{
          "messages":[
           {
            "sender":"-000pcMJDSDHK-UvK012b10KKXmCvWmVF8o",
            "destinations":[
             {
              "to":"u5NkbnslAgxpOelvH01Y+rs7Uw="
             }
            ],
            "content":{
             "mediaUrl":"http://example.com/image.png",
             "type":"IMAGE"
            }
           }
          ]
         }
        },
        "Text message":{
         "summary":"Text message",
         "value":{
          "messages":[
           {
            "sender":"-000pcMJDSDHK-UvK012b10KKXmCvWmVF8o",
            "destinations":[
             {
              "to":"u5NkbnslAgxpOelvH01Y+rs7Uw="
             }
            ],
            "content":{
             "text":"sample text",
             "type":"TEXT"
            }
           }
          ]
         }
        },
        "Text message with reply":{
         "summary":"Text message with reply",
         "value":{
          "messages":[
           {
            "sender":"-000pcMJDSDHK-UvK012b10KKXmCvWmVF8o",
            "destinations":[
             {
              "to":"u5NkbnslAgxpOelvH01Y+rs7Uw="
             }
            ],
            "content":{
             "text":"sample reply text",
             "replyToMessageId":"7199695882537746695",
             "type":"TEXT"
            }
           }
          ]
         }
        },
        "Share post message":{
         "summary":"Share post message",
         "value":{
          "messages":[
           {
            "sender":"-000pcMJDSDHK-UvK012b10KKXmCvWmVF8o",
            "destinations":[
             {
              "to":"u5NkbnslAgxpOelvH01Y+rs7Uw="
             }
            ],
            "content":{
             "postId":"id123456789",
             "type":"SHARE_POST"
            }
           }
          ]
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ResponseEnvelopeMessageResponseMessageResponseDetails"
        },
        "examples":{
         "Successful response":{
          "summary":"Successful response",
          "value":{
           "bulkId":"a28dd97c-2222-4fcf-99f1-0b557ed381da",
           "messages":[
            {
             "messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
             "status":{
              "groupId":1,
              "groupName":"PENDING",
              "id":7,
              "name":"PENDING_ENROUTE",
              "description":"Message sent to next instance"
             },
             "destination":"u5NkbnslAgxpOelvH01Y+rs7Uw="
            }
           ]
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/ApiError"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "errorCode":"E400",
           "description":"Request cannot be processed.",
           "action":"Check the syntax, violations and adjust the request.",
           "violations":[
            {
             "property":"property.path",
             "violation":"Violation message."
            }
           ],
           "resources":[]
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiError401"
     },
     "403":{
      "$ref":"#/components/responses/ApiError403"
     },
     "500":{
      "$ref":"#/components/responses/ApiError500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "message:send",
     "tiktok:message:send",
     "tiktok:manage"
    ],
    "x-is-early-access":true
   }
  },
  "/tiktok/1/events":{
   "post":{
    "tags":[
     "channels",
     "tiktok",
     "tiktok-events"
    ],
    "summary":"Send TikTok events",
    "description":"Send typing indicator or mark-as-read events to TikTok users in active conversations with your TikTok Business Account.",
    "externalDocs":{
     "description":"Learn more about the TikTok channel and its use cases",
     "url":"https://www.infobip.com/docs/tiktok"
    },
    "operationId":"send-tiktok-events",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokEventRequest"
       },
       "examples":{
        "Typing indicator":{
         "summary":"Typing indicator",
         "value":{
          "events":[
           {
            "sender":"-000pcMJDSDHK-UvK012b10KKXmCvWmVF8o",
            "destinations":[
             {
              "to":"u5NkbnslAgxpOelvH01Y+rs7Uw="
             }
            ],
            "content":{
             "type":"TYPING_INDICATOR"
            }
           }
          ]
         }
        },
        "Mark as read":{
         "summary":"Mark as read",
         "value":{
          "events":[
           {
            "sender":"-000pcMJDSDHK-UvK012b10KKXmCvWmVF8o",
            "destinations":[
             {
              "to":"u5NkbnslAgxpOelvH01Y+rs7Uw="
             }
            ],
            "content":{
             "type":"MARK_AS_READ"
            }
           }
          ]
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ResponseEnvelopeMessageResponseMessageResponseDetails"
        },
        "examples":{
         "Success":{
          "summary":"Success",
          "value":{
           "bulkId":"a28dd97c-2222-4fcf-99f1-0b557ed381da",
           "messages":[
            {
             "messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
             "status":{
              "groupId":1,
              "groupName":"PENDING",
              "id":26,
              "name":"PENDING_ACCEPTED",
              "description":"Message sent to next instance"
             },
             "destination":"u5NkbnslAgxpOelvH01Y+rs7Uw="
            }
           ]
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/ApiError"
        },
        "examples":{
         "Bad request":{
          "summary":"Bad request",
          "value":{
           "errorCode":"E400",
           "description":"Request cannot be processed.",
           "action":"Check the syntax, violations and adjust the request.",
           "violations":[
            {
             "property":"property.path",
             "violation":"Violation message."
            }
           ],
           "resources":[]
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiError401"
     },
     "403":{
      "$ref":"#/components/responses/ApiError403"
     },
     "500":{
      "$ref":"#/components/responses/ApiError500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "message:send",
     "tiktok:message:send",
     "tiktok:manage"
    ],
    "x-is-early-access":true
   }
  },
  "/tiktok/1/reports":{
   "get":{
    "tags":[
     "channels",
     "tiktok",
     "logs-and-status-reports-tiktok"
    ],
    "summary":"Get TikTok delivery reports",
    "description":"Use this endpoint to pull delivery reports when your endpoint does not receive real-time delivery reports. Each request returns the latest batch of delivery reports from the last 48 hours. Each report is returned only once.",
    "externalDocs":{
     "description":"Learn more about the TikTok channel and its use cases",
     "url":"https://www.infobip.com/docs/tiktok"
    },
    "operationId":"get-outbound-tiktok-message-delivery-reports",
    "parameters":[
     {
      "name":"bulkId",
      "in":"query",
      "description":"The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"messageId",
      "in":"query",
      "description":"The ID that uniquely identifies the message sent.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"limit",
      "in":"query",
      "description":"Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":50,
       "maximum":1000
      },
      "example":1
     },
     {
      "name":"entityId",
      "in":"query",
      "description":"Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"promotional-traffic-entity"
     },
     {
      "name":"applicationId",
      "in":"query",
      "description":"Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"marketing-automation-application"
     },
     {
      "name":"campaignReferenceId",
      "in":"query",
      "description":"ID of a campaign that was sent in the message.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"summersale"
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryReports"
        },
        "examples":{
         "Delivery reports":{
          "summary":"Delivery reports",
          "value":{
           "results":[
            {
             "bulkId":"a28dd97c-2222-4fcf-99f1-0b557ed381da",
             "price":{
              "pricePerMessage":0.01,
              "currency":"EUR"
             },
             "status":{
              "groupId":3,
              "groupName":"DELIVERED",
              "id":5,
              "name":"DELIVERED_TO_HANDSET",
              "description":"Message delivered to handset"
             },
             "error":{
              "groupId":0,
              "groupName":"OK",
              "id":0,
              "name":"NO_ERROR",
              "description":"No Error",
              "permanent":false
             },
             "messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
             "to":"u5NkbnslAgxpOelvH01Y+rs7Uw=",
             "sender":"-000pcMJDSDHK-UvK012b10KKXmCvWmVF8o",
             "sentAt":"2023-09-26T10:52:15.457+0000",
             "doneAt":"2023-09-26T10:52:15.799+0000",
             "messageCount":1,
             "platform":{
              "entityId":"promotional-traffic-entity",
              "applicationId":"marketing-automation-application"
             }
            }
           ]
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiError401"
     },
     "403":{
      "$ref":"#/components/responses/ApiError403"
     },
     "500":{
      "$ref":"#/components/responses/ApiError500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "message:send",
     "tiktok:message:send",
     "tiktok:manage"
    ],
    "x-is-early-access":true
   }
  },
  "/tiktok/1/logs":{
   "get":{
    "tags":[
     "channels",
     "tiktok",
     "logs-and-status-reports-tiktok"
    ],
    "summary":"Get TikTok message logs",
    "description":"Use this endpoint to retrieve outbound TikTok message logs for display in a user interface. Logs are available for the last 48 hours.",
    "operationId":"get-outbound-tiktok-message-logs",
    "parameters":[
     {
      "name":"sender",
      "in":"query",
      "description":"The sender ID which can be alphanumeric or numeric.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"destination",
      "in":"query",
      "description":"Message destination address.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     },
     {
      "name":"bulkId",
      "in":"query",
      "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      },
      "example":"BULK-ID-123-xyz"
     },
     {
      "name":"messageId",
      "in":"query",
      "description":"Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      },
      "example":"MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz"
     },
     {
      "name":"generalStatus",
      "in":"query",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageGeneralStatus"
      }
     },
     {
      "name":"sentSince",
      "in":"query",
      "description":"The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string",
       "format":"date-time"
      },
      "example":"2020-02-22T17:42:05.390+01:00"
     },
     {
      "name":"sentUntil",
      "in":"query",
      "description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string",
       "format":"date-time",
       "description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
       "example":"2020-02-23T17:42:05.39+01:00"
      },
      "example":"2020-02-23T17:42:05.390+01:00"
     },
     {
      "name":"limit",
      "in":"query",
      "description":"Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":50,
       "maximum":1000
      }
     },
     {
      "name":"entityId",
      "in":"query",
      "description":"Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"promotional-traffic-entity"
     },
     {
      "name":"applicationId",
      "in":"query",
      "description":"Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"marketing-automation-application"
     },
     {
      "name":"campaignReferenceId",
      "in":"query",
      "description":"ID of a campaign that was sent in the message. May contain multiple comma-separated values.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"string"
       }
      },
      "example":"summersale"
     },
     {
      "name":"useCursor",
      "in":"query",
      "description":"Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"boolean"
      }
     },
     {
      "name":"cursor",
      "in":"query",
      "description":"Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      }
     }
    ],
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.LogResponseLogTikTokOutboundMessageContent"
        },
        "examples":{
         "Log result":{
          "summary":"Log result",
          "value":{
           "results":[
            {
             "sender":"-000pcMJDSDHK-UvK012b10KKXmCvWmVF8o",
             "destination":"u5NkbnslAgxpOelvH01Y+rs7Uw=",
             "bulkId":"a28dd97c-2222-4fcf-99f1-0b557ed381da",
             "messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
             "sentAt":"2023-09-26T10:52:15.457+0000",
             "doneAt":"2023-09-26T10:52:15.799+0000",
             "messageCount":1,
             "price":{
              "pricePerMessage":0.01,
              "currency":"EUR"
             },
             "status":{
              "groupId":3,
              "groupName":"DELIVERED",
              "id":5,
              "name":"DELIVERED_TO_HANDSET",
              "description":"Message delivered to handset"
             },
             "error":{
              "groupId":0,
              "groupName":"OK",
              "id":0,
              "name":"NO_ERROR",
              "description":"No Error",
              "permanent":false
             },
             "platform":{
              "entityId":"promotional-traffic-entity",
              "applicationId":"marketing-automation-application"
             },
             "content":{
              "text":"Hello!",
              "type":"TEXT"
             }
            }
           ]
          }
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiError401"
     },
     "403":{
      "$ref":"#/components/responses/ApiError403"
     },
     "429":{
      "$ref":"#/components/responses/ApiError429"
     },
     "500":{
      "$ref":"#/components/responses/ApiError500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "tiktok:logs:read",
     "tiktok:manage"
    ],
    "x-is-early-access":true,
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":120,
      "numberOfTimeUnits":0,
      "timeUnit":"m"
     }
    ]
   }
  }
 },
 "components":{
  "schemas":{
   "ApiError":{
    "type":"object",
    "properties":{
     "errorCode":{
      "type":"string",
      "description":"An error code uniquely identifying the error case."
     },
     "description":{
      "type":"string",
      "description":"A detailed description of an error."
     },
     "action":{
      "type":"string",
      "description":"An action that should be taken to recover from the error."
     },
     "violations":{
      "type":"array",
      "description":"List of violations that caused the error.",
      "items":{
       "$ref":"#/components/schemas/ApiErrorViolation"
      }
     },
     "resources":{
      "type":"array",
      "description":"List of available resources to recover from the error.",
      "items":{
       "$ref":"#/components/schemas/ApiErrorResource"
      }
     }
    },
    "required":[
     "action",
     "description",
     "errorCode",
     "resources",
     "violations"
    ],
    "title":"ApiError"
   },
   "ApiErrorResource":{
    "type":"object",
    "description":"List of available resources to recover from the error.",
    "properties":{
     "name":{
      "type":"string",
      "description":"Resource name."
     },
     "url":{
      "type":"string",
      "description":"Resource URL."
     }
    },
    "title":"ApiErrorResource"
   },
   "ApiErrorViolation":{
    "type":"object",
    "description":"List of violations that caused the error.",
    "properties":{
     "property":{
      "type":"string",
      "description":"Request property that caused the error."
     },
     "violation":{
      "type":"string",
      "description":"Detailed violation description."
     }
    },
    "title":"ApiErrorViolation"
   },
   "e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.AdvancedMessageDeliveryReporting":{
    "type":"object",
    "description":"Provides options for configuring the delivery report behavior.",
    "properties":{
     "url":{
      "type":"string",
      "description":"The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`."
     },
     "intermediateReport":{
      "type":"boolean",
      "description":"The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`."
     },
     "notify":{
      "type":"boolean",
      "description":"Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to 'true' or not defined, your Subscription settings will apply."
     },
     "receiveTriggeredFailoverReports":{
      "type":"boolean",
      "description":"Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`."
     }
    },
    "title":"AdvancedMessageDeliveryReporting"
   },
   "e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.AdvancedWebhooksWithSeen":{
    "type":"object",
    "description":"Provides options for configuring message webhooks.",
    "properties":{
     "delivery":{
      "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.AdvancedMessageDeliveryReporting"
     },
     "contentType":{
      "type":"string",
      "description":"Preferred delivery report content type, `application/json` or `application/xml`."
     },
     "callbackData":{
      "type":"string",
      "description":"Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.",
      "maxLength":4000,
      "minLength":0
     },
     "seen":{
      "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SeenStatusReporting"
     }
    },
    "title":"AdvancedWebhooksWithSeen"
   },
   "e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ClientPriority":{
    "type":"string",
    "description":"Client priority set on request. Must be 'HIGH', 'STANDARD' or 'LOW'.",
    "enum":[
     "HIGH",
     "STANDARD",
     "LOW"
    ],
    "title":"ClientPriority"
   },
   "e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.Context":{
    "type":"object",
    "description":"Information about the message to which the end user responded.",
    "properties":{
     "id":{
      "type":"string",
      "description":"Id of the message to which the end user responded."
     }
    },
    "title":"Context"
   },
   "e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.CursorPageInfo":{
    "type":"object",
    "description":"Cursor information.",
    "properties":{
     "limit":{
      "type":"integer",
      "format":"int32",
      "description":"Requested limit."
     },
     "nextCursor":{
      "type":"string",
      "description":"The `cursor` value you will use in your next request to fetch the subsequent set of results."
     }
    },
    "readOnly":true,
    "title":"CursorPageInfo"
   },
   "e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DefaultEventRequestOptions":{
    "type":"object",
    "description":"Options applicable to all events in the request.",
    "properties":{
     "schedule":{
      "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.RequestSchedulingSettings"
     }
    },
    "title":"DefaultEventRequestOptions"
   },
   "e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DefaultSmsFailover":{
    "type":"object",
    "description":"Failover SMS message to be sent if the original message could not be delivered.",
    "properties":{
     "sender":{
      "type":"string",
      "description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)."
     },
     "text":{
      "type":"string",
      "description":"Content of the message being sent."
     },
     "validityPeriod":{
      "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ValidityPeriod"
     },
     "regional":{
      "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.RegionalOptions"
     }
    },
    "required":[
     "text"
    ],
    "title":"DefaultSmsFailover"
   },
   "e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryDay":{
    "type":"string",
    "description":"Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.",
    "enum":[
     "MONDAY",
     "TUESDAY",
     "WEDNESDAY",
     "THURSDAY",
     "FRIDAY",
     "SATURDAY",
     "SUNDAY"
    ],
    "title":"DeliveryDay"
   },
   "e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryReport":{
    "type":"object",
    "description":"Collection of reports, one per every message.",
    "properties":{
     "bulkId":{
      "type":"string",
      "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request."
     },
     "price":{
      "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessagePrice"
     },
     "status":{
      "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageStatus"
     },
     "error":{
      "$ref":"#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageError"
     },
     "messageId":{
      "type":"string",
      "description":"Unique message ID."
     },
     "to":{
      "type":"string",
      "description":"Message destination address."
     },
     "sender":{
      "type":"string",
      "description":"The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`)."
     },
     "sentAt":{
      "type":"string",
      "format":"date-time",
      "description":"Date and time when the message was sent. Has the following format: yyyy-MM-dd'T'HH:mm:s

# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/openapi/infobip-tiktok-openapi.json
Infobip TikTok API

Documentation

Specifications

Other Resources

OpenAPI Specification
