ข้ามไปยังเนื้อหา
คู่มือผู้ใช้การสนับสนุน ขอสาธิต เข้าสู่ระบบ
Pushwoosh.com

Start by API

POST https://journey.pushwoosh.com/api/journey/{id}/start/external

เพิ่มชุดผู้ใช้เข้าไปใน API entry point ของ Journey ใช้เพื่อขับเคลื่อน Journey จากแบ็กเอนด์ของคุณเอง ตัวอย่างเช่น เริ่มโฟลว์การเริ่มต้นใช้งานเมื่อผู้ใช้ลงทะเบียนบนเซิร์ฟเวอร์ของคุณเสร็จสิ้น

ข้อกำหนดเบื้องต้น

Anchor link to
  • Journey อยู่ในสถานะ Running
  • Journey มี API entry point เพียงหนึ่งจุดเท่านั้น (องค์ประกอบ “Start by API”) และองค์ประกอบนั้นไม่ได้ถูกปิดใช้งาน
  • ชื่อแอตทริบิวต์ที่คุณส่งต้องตรงกับแอตทริบิวต์ที่กำหนดค่าไว้ใน API entry point นั้น

พารามิเตอร์ของ Path

Anchor link to
ชื่อประเภทคำอธิบาย
idstringJourney ID ของ Journey ที่กำลังทำงานอยู่

ส่วนหัวของคำขอ (Request headers)

Anchor link to
ชื่อจำเป็นค่า
Content-Typeใช่application/json
Authorizationใช่Api <server_api_token> ดู Server API token

เนื้อหาของคำขอ (Request body)

Anchor link to

เนื้อหาของคำขอมีอ็อบเจ็กต์ payload เพียงหนึ่งรายการ คุณต้องระบุ เพียงหนึ่งอย่างเท่านั้น จาก users, hwids หรือ filter เพื่อเลือกผู้ที่จะเข้าสู่ Journey

ฟิลด์ประเภทคำอธิบาย
payload.usersstring[]User IDs ที่จะเข้าสู่ระบบ ไม่สามารถใช้ร่วมกับ hwids และ filter ได้
payload.hwidsstring[]HWIDs ที่จะเข้าสู่ระบบ ไม่สามารถใช้ร่วมกับ users และ filter ได้
payload.filterstringนิพจน์ seglang ที่เลือกกลุ่มเป้าหมาย ไม่สามารถใช้ร่วมกับ users และ hwids ได้
payload.attribute_valuesmap<string, string>ไม่บังคับ ค่าสำหรับแอตทริบิวต์ที่กำหนดเองที่กำหนดไว้ใน API entry point แต่ละคีย์ต้องตรงกับชื่อแอตทริบิวต์ที่กำหนดค่าไว้

ตัวอย่างคำขอ

Anchor link to
เพิ่มผู้ใช้ที่ระบุ
Anchor link to
Terminal window
curl -X POST 'https://journey.pushwoosh.com/api/journey/<journey_id>/start/external' \
  -H 'Authorization: Api YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "payload": {
      "users": ["user-123", "user-456"]
    }
  }'
เพิ่มผู้ใช้ที่ระบุพร้อมแอตทริบิวต์
Anchor link to
{
  "payload": {
    "users": ["user-123", "user-456"],
    "attribute_values": {
      "promo_code": "SUMMER25",
      "tier": "gold"
    }
  }
}
เพิ่มกลุ่มเป้าหมายโดยใช้ตัวกรอง
Anchor link to
{
  "payload": {
    "filter": "A(\"XXXXX-XXXXX\").tags(\"City\").eq(\"London\")"
  }
}

การตอบกลับ (Response)

Anchor link to
{
  "request_uuid": "9f8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d"
}
ฟิลด์ประเภทคำอธิบาย
request_uuidstringตัวระบุของคำขอเข้าที่ยอมรับ คำขอจะถูกประมวลผลแบบอะซิงโครนัส

หัวข้อที่เกี่ยวข้อง

Anchor link to
Lifecycle
รับสถิติ Journey
ภาษา Segmentation