กำหนด API ที่กำหนดเอง

API ที่กำหนดเองขาออก

ช่องทางที่ใช้งานได้: SMS, กำหนดเอง

เมื่อคุณสร้างช่องทางที่กำหนดเองใน Dynamics 365 Customer Insights - Journeys คุณต้องกำหนด API ที่กำหนดเองขาออก เพื่อโทรระหว่างรันไทม์การเดินทาง API ที่กำหนดเองเป็นจุดเริ่มต้นสำหรับเรียกใช้โค้ดที่กำหนดเอง ซึ่งเรียก API ของผุ้ให้บริการ และต้องยอมรับสัญญาที่กำหนดโดยการเดินทางของ Customer Insights - Journeys และส่งคืนการตอบกลับ API ที่กำหนดเองขาออกจะถูกกำหนดให้กับแอตทริบิวต์ msdyn_outboundendpointurltemplate ที่ ขั้นตอนข้อกำหนดของช่องทาง

สัญญาที่ API ที่กำหนดเองขาออกควรใช้ต้องมีพารามิเตอร์อินพุตหนึ่งรายการ (ส่วนข้อมูล) และแอตทริบิวต์เอาต์พุตหนึ่งรายการ (การตอบสนอง)

• ส่วนข้อมูล เป็น JSON แบบซีเรียลไลซ์ที่มีสัญญาต่อไปนี้:

  • ChannelDefinitionId: GUID – รหัสข้อกำหนดช่องทาง
  • RequestId: สตริง – รหัสคำขอ
  • จาก: สตริง – ผู้ส่ง (อินสแตนซ์ช่องทาง)
  • ถึง: สตริง – ผู้รับ
  • ข้อความ: พจนานุกรม <สตริง, สตริง> - มีส่วนของข้อความทั้งหมดสำหรับช่องทาง คีย์คือชื่อส่วนของข้อความ เช่น ค่าของแอตทริบิวต์ msdyn_name ที่สอดคล้องกัน
  • MarketingAppContext: ออบเจ็กต์ - ออบเจ็กต์ที่แสดงบริบทของการส่ง ออบเจ็กต์นี้ใช้ได้เฉพาะเมื่อมีการดำเนินการส่งจากแอปพลิเคชัน Customer Insights - Journeys ออบเจ็กต์ประกอบด้วยฟิลด์ต่อไปนี้:
    • CustomerJourneyId: สตริง - รหัสของการเดินทางของลูกค้าที่เริ่มต้นการเรียกใช้ Null เมื่อมีการร้องขอการส่งจากการทดสอบส่ง
    • UserId: GUID - รหัสของผู้ใช้ที่ได้รับข้อความ Null เมื่อมีการร้องขอการส่งจากการทดสอบส่ง
    • UserEntityType: สตริง - ชนิดของเอนทิตีที่เป็นเจ้าหน้าที่ของผู้ใช้ที่ได้รับข้อความ Null เมื่อมีการร้องขอการส่งจากการทดสอบส่ง
    • IsTestSend: แบบบูลีน - จริง เมื่อเริ่มการส่งจากการทดสอบส่ง มิฉะนั้น เท็จ

• การตอบสนองเป็น JSON แบบซีเรียลไลซ์ที่มีสัญญาต่อไปนี้:

  • ChannelDefinitionId: GUID – รหัสข้อกำหนดช่องทาง
  • MessageId: สตริง – (ไม่บังคับ) รหัสข้อความ ไม่บังคับ; อาจมีอยู่ในการตอบสนอง API ของผู้ให้บริการ
  • RequestId: สตริง – รหัสคำขอ ควรเท่ากับค่ารหัสคำขอภายในส่วนข้อมูลคำขอ
  • สถานะ: สตริง – ค่าที่เป็นไปได้คือ:
    • ไม่ได้ส่ง – มีความพยายามที่จะดำเนินการส่งไปยังผู้ให้บริการ แต่ถูกปฏิเสธโดยไม่มีความเป็นไปได้ที่จะลองอีกครั้ง
    • ส่งแล้ว – ผู้ให้บริการยอมรับคำขอส่งเรียบร้อยแล้ว

API ที่กำหนดเองของรายการจัดส่ง

ช่องทางที่ใช้งานได้: SMS, กำหนดเอง

หากช่องทางของคุณรองรับรายงานหรือสถานะการจัดส่งข้อความ คุต้องกำหนด API ที่กำหนดเองของรายงานการจัดส่ง ผู้ให้บริการจะเรียก API ของคุณ และจะต้องเรียก API msdyn_D365ChannelsNotification ของโซลูชันพื้นฐาน ซึ่งส่งคืนข้อมูลไปยัง Dataverse ข้อมูลนี้จะพร้อมใช้งานในการวิเคราะห์ Customer Insights - Journeys

API ที่กำหนดเองของรายงานการจัดส่งจะเรียกAPI msdyn_D365ChannelsNotification โดยมีสัญญาเป็นพารามิเตอร์อินพุตเดียว:

• notificationPayLoad เป็น JSON แบบซีเรียลไลซ์ที่มีสัญญาต่อไปนี้:

  • ChannelDefinitionId: GUID – รหัสข้อกำหนดช่องทาง
  • RequestId: สตริง – รหัสคำขอ
  • MessageId: สตริง – รหัสข้อความ
  • จาก: สตริง – ผู้ส่ง (อินสแตนซ์ช่องทาง)
  • OrganizationId: สตริง – รหัสองค์กร
  • สถานะ: สตริง – สถานะรายงานการจัดส่ง ค่าที่เป็นไปได้คือ:
    • ส่งถึงแล้ว – ข้อความที่ยอมรับถูกส่งถึงเป้าหมายเรียบร้อยแล้ว
    • ส่งไม่ถึง – ข้อความที่ยอมรับยังส่งไม่ถึงเป้าหมาย

API ที่กำหนดเองขาออก

ช่องทางที่ใช้งานได้: SMS

หากช่องของคุณรองรับคำขอขาเข้า คุณต้องกำหนด API ที่กำหนดเองขาเข้า ผู้ให้บริการจะเรียก API ของคุณ และจะต้องเรียก API msdyn_D365ChannelsInbound ของโซลูชันพื้นฐาน ซึ่งส่งคืนข้อมูลไปยัง Dataverse

API ที่กำหนดเองขาเข้าจะเรียก API msdyn_D365ChannelsInbound โดยมีสัญญาเป็นพารามิเตอร์อินพุตเดียว:

• inboundPayLoad เป็น JSON แบบซีเรียลไลซ์ที่มีสัญญาต่อไปนี้:

  • ChannelDefinitionId: GUID – รหัสข้อกำหนดช่องทาง
  • ถึง: สตริง - หมายเลขโทรศัพท์ C1 (อินสแตนซ์ช่องทาง)
  • จาก: สตริง - ที่ติดต่อผู้ใช้ C2
  • OrganizationId: สตริง – รหัสองค์กร
  • ข้อความ: พจนานุกรม <สตริง, สตริง> - มีส่วนของข้อความทั้งหมดสำหรับช่องทาง