Channel Management/Publishing

Create Douyin Check-in

Create a Douyin offline check-in publish entry. The API key belongs to the integration partner; the person scanning the QR code does not need an AiToEarn account and does not need to authorize or bind a Douyin account in advance.

Store recordId. You can display the server-generated userAction.qrCodeUrl directly or generate your own QR code from userAction.shortLink to customize its size, styling, or logo. Scanning the code opens the Douyin App, where the user confirms and completes publishing. schemeUrl can be used by a mobile page to attempt to open the Douyin App directly. The initial status is always 8, which means user action is required and does not indicate success.

After publishing completes, AiToEarn updates the publish record from the Douyin webhook. From the integration backend, use the same API key that created the record to call the existing GET /api/v2/channels/publish/records/{recordId} endpoint. The QR code and launch links expire; use expiresAt as the source of truth and create a new entry after expiration.

Images and video cannot be mixed. Up to 12 JPG, JPEG, PNG, or BMP images are supported, with a maximum size of 20 MB each. One MP4, AVI, MKV, or MOV video is supported, with a maximum size of 1 GB and a maximum duration of 3,600 seconds. Each API key can call this endpoint up to 30 times per 60 seconds.

POST

api

channels

douyin

open

offline-qr

curl --request POST \
  --url https://aitoearn.cn/api/v2/channels/douyin/open/offline-qr \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data @- <<EOF
{
  "content": {
    "title": "Offline check-in",
    "body": "Joining today's event #OfflineCheckIn",
    "media": [
      {
        "url": "https://assets.example.com/check-in.mp4"
      }
    ],
    "cover": {
      "url": "https://assets.example.com/check-in-cover.jpg"
    }
  }
}
EOF

{
  "code": 0,
  "message": "Request succeeded",
  "data": {
    "recordId": "66c5f23ec7d9b89d23e6b102",
    "status": 8,
    "userAction": {
      "shareId": "7400000000000000000",
      "schemeUrl": "snssdk1128://openplatform/share?state=7400000000000000000",
      "shortLink": "https://aitoearn.cn/api/shortLink/abc123",
      "qrCodeUrl": "data:image/png;base64,iVBORw0KGgo...",
      "expiresAt": "2026-08-22T13:00:00.000Z"
    }
  },
  "requestId": "request_xxx"
}

Authorizations

X-Api-Key

string

header

required

Need to get API Key from AiToEarn. Click to go to "API Key Obtaining Tutorial".

Body

application/json

content

object

required

Offline check-in publish content

Hide child attributes

content.media

object[]

required

Image or video list containing at least one media item. Up to 12 images or one video is supported, and images and video cannot be mixed.

Required array length: 1 - 12 elements

Hide child attributes

content.media.url

string<uri>

required

Media URL

content.media.options

object

Media handling options

Hide child attributes

content.media.options.adaptation

object

Media format conversion options

Hide child attributes

content.media.options.adaptation.imageFormat

enum<string>

Image and cover format conversion targets

Available options:

off,

auto,

jpeg,

png,

webp

content.title

string

Title, up to 30 characters

Maximum string length: 30

content.body

string

Body text. Hashtags can be included using #topic, with up to 5 topics. The title and body excluding topics can contain up to 1,000 characters in total.

content.cover

object

Optional video cover using a publicly accessible image URL.

Hide child attributes

content.cover.url

string<uri>

required

Cover URL

content.cover.options

object

Media handling options

Hide child attributes

content.cover.options.adaptation

object

Media format conversion options

Hide child attributes

content.cover.options.adaptation.imageFormat

enum<string>

Image and cover format conversion targets

Available options:

off,

auto,

jpeg,

png,

webp

option

object

TikTok publishing options

Hide child attributes

option.short_title

string

Douyin short title, up to 12 characters

Maximum string length: 12

option.cover_tsp

integer

Video cover timestamp in milliseconds

Required range: x >= 0

option.download_type

enum<integer>

Download permission: 1 allows downloads and 2 disallows downloads

Available options:

1,

2

option.private_status

enum<integer>

Visibility: 0 is public, 1 is private, and 2 is visible to friends

Available options:

0,

1,

2

option.poi_id

string

Douyin location POI ID

Response

200 - application/json

The request has been processed by the service. Business success is determined by whether the response body has code === 0.

code

integer

required

Business status code. 0 means success; non-zero means a business error.

message

string

required

Response message.

data

object

Hide child attributes

data.recordId

string

required

AiToEarn publish record ID

data.status

enum<integer>

required

Publish status. The initial value is always 8, meaning that the user must continue in the Douyin App.

Available options:

8

data.userAction

object

required

Information required for the user to complete publishing on Douyin

Hide child attributes

Douyin share ID

data.userAction.schemeUrl

string

required

Scheme URL used to open the Douyin App

data.userAction.shortLink

string

required

HTTPS launch short link that the integration can use to generate and customize its own QR code

data.userAction.qrCodeUrl

string

required

Server-generated QR code PNG Data URL that can be used directly as an img src

data.userAction.expiresAt

string<date-time>

required

Expiration time of the App launch links

requestId

string

Request ID.

timestamp

integer

Error response timestamp in Unix milliseconds.

Last modified on September 29, 2026

curl --request POST \
  --url https://aitoearn.cn/api/v2/channels/douyin/open/offline-qr \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data @- <<EOF
{
  "content": {
    "title": "Offline check-in",
    "body": "Joining today's event #OfflineCheckIn",
    "media": [
      {
        "url": "https://assets.example.com/check-in.mp4"
      }
    ],
    "cover": {
      "url": "https://assets.example.com/check-in-cover.jpg"
    }
  }
}
EOF

{
  "code": 0,
  "message": "Request succeeded",
  "data": {
    "recordId": "66c5f23ec7d9b89d23e6b102",
    "status": 8,
    "userAction": {
      "shareId": "7400000000000000000",
      "schemeUrl": "snssdk1128://openplatform/share?state=7400000000000000000",
      "shortLink": "https://aitoearn.cn/api/shortLink/abc123",
      "qrCodeUrl": "data:image/png;base64,iVBORw0KGgo...",
      "expiresAt": "2026-08-22T13:00:00.000Z"
    }
  },
  "requestId": "request_xxx"
}