사용자 지정 API 정의

  • 아티클

아웃바운드 사용자 지정 API

적용 가능한 채널: SMS, 사용자 지정

Dynamics 365 Customer Insights - Journeys에서 사용자 지정 채널을 만들 때 여정 런타임 중에 호출할 아웃바운드 사용자 지정 API를 정의해야 합니다. 사용자 지정 API는 사용자 지정 코드 실행을 위한 진입점입니다. 공급자의 API를 호출하고 Customer Insights - Journeys에서 정의한 계약을 수락하고 응답을 반환해야 합니다. 아웃바운드 사용자 지정 API는 채널 정의 단계에서 특성 msdyn_outboundendpointurltemplate에 할당됩니다.

아웃바운드 사용자 지정 API가 구현해야 하는 계약에는 하나의 입력 매개 변수(페이로드)와 하나의 출력 특성(응답)이 있어야 합니다.

  • 페이로드는 다음 계약이 포함된 직렬화된 JSON입니다.

    • ChannelDefinitionId: GUID – 채널 정의 ID입니다.
    • RequestId: 문자열 – 요청 ID입니다.
    • 보낸 사람: 문자열 – 보낸 사람(채널 인스턴스)입니다.
    • 받는 사람: 문자열 – 받는 사람.
    • 메시지: 사전 <문자열, 문자열> - 채널의 모든 메시지 부분을 포함합니다. 키는 해당 msdyn_name 특성의 값과 같은 메시지 부분 이름입니다.
    • MarketingAppContext: 개체 - 제출 컨텍스트를 나타내는 개체입니다. 이 개체는 제출이 Customer Insights - Journeys 애플리케이션에서 실행될 때만 사용할 수 있습니다. 개체에는 다음 필드가 포함됩니다.
      • CustomerJourneyId: 문자열 - 호출을 시작하는 고객 여정의 ID입니다. 테스트 전송에서 제출이 요청된 경우 Null입니다.
      • UserId: GUID - 메시지를 받는 사용자의 ID입니다. 테스트 전송에서 제출이 요청된 경우 Null입니다.
      • UserEntityType: 문자열 - 메시지를 수신하는 사용자를 나타내는 엔터티 유형입니다. 테스트 전송에서 제출이 요청된 경우 Null입니다.
      • IsTestSend: 부울 - 테스트 전송에서 제출이 시작된 경우 True이며 그렇지 않을 경우 False입니다.

  • 응답은 다음 계약이 포함된 직렬화된 JSON입니다.

    • ChannelDefinitionId: GUID – 채널 정의 ID입니다.
    • MessageId: 문자열 – (선택 사항) 메시지 ID입니다. 선택 사항으로 공급자의 API 응답에 존재할 수 있습니다.
    • RequestId: 문자열 – 요청 ID입니다. 요청 페이로드 내의 요청 ID 값과 같아야 합니다.
    • 상태: 문자열 – 가능한 값은 다음과 같습니다.
      • NotSent – 제공자에게 제출을 실행하려는 시도가 있었지만 재시도할 가능성 없이 거부되었습니다.
      • Sent – 제출 요청이 공급자에 의해 성공적으로 수락되었습니다.

배달 보고서 사용자 지정 API

적용 가능한 채널: SMS, 사용자 지정

채널에서 메시지 전달 보고서 또는 상태를 지원하는 경우 배달 보고서 사용자 지정 API를 정의해야 합니다. 귀하의 API는 공급자에 의해 호출되며 Dataverse에 정보를 반환하는 기본 솔루션의 msdyn_D365ChannelsNotification API를 호출해야 합니다. 이 정보는 Customer Insights - Journeys 분석에서 사용할 수 있습니다.

배달 보고서 사용자 지정 API는 계약을 하나의 입력 매개 변수로 사용하여 msdyn_D365ChannelsNotification API를 호출합니다.

  • notificationPayLoad는 다음 계약을 포함하는 직렬화된 JSON입니다.

    • ChannelDefinitionId: GUID – 채널 정의 ID입니다.
    • RequestId: 문자열 – 요청 ID입니다.
    • MessageId: 문자열 – 메시지 ID입니다.
    • 보낸 사람: 문자열 – 보낸 사람(채널 인스턴스)입니다.
    • OrganizationId: 문자열 – 조직 ID입니다.
    • 상태: 문자열 – 배달 보고서 상태입니다. 가능한 값은 다음과 같습니다.
      • Delivered – 수락된 메시지가 대상에 성공적으로 전달되었습니다.
      • NotDelivered – 수락된 메시지가 대상에 성공적으로 전달되지 않았습니다.

인바운드 사용자 지정 API

적용 가능한 채널: SMS

채널이 인바운드 요청을 지원하는 경우 인바운드 사용자 지정 API를 정의해야 합니다. 귀하의 API는 공급자에 의해 호출되며 Dataverse에 정보를 반환하는 기본 솔루션의 msdyn_D365ChannelsInbound API를 호출해야 합니다.

인바운드 사용자 지정 API는 계약을 하나의 입력 매개 변수로 사용하여 msdyn_D365ChannelsInbound API를 호출합니다.

  • inboundPayLoad는 다음 계약이 포함된 직렬화된 JSON입니다.

    • ChannelDefinitionId: GUID – 채널 정의 ID입니다.
    • 받는 사람: 문자열 - C1 전화번호(채널 인스턴스)입니다.
    • 보낸 사람: 문자열 - C2 사용자 연락처입니다.
    • OrganizationId: 문자열 – 조직 ID입니다.
    • 메시지: 사전 <문자열, 문자열> - 채널의 모든 메시지 부분을 포함합니다.