Kopīgot, izmantojot

Pašpiegādes paziņojumu ierīces reģistrācija lietojumprogrammu izstrādātājiem

  • Raksts

Lai uzzinātu vairāk par vispārējo pašpiegādes paziņojumu Customer Insights - Journeys iestatīšanas pieeju, apmeklējiet pašpiegādes paziņojumu iestatīšanas pārskatu.

Lai iespējotu pašpiegādes paziņojumus Customer Insights - Journeys, jums jāveic šādas darbības:

  1. Pašpiegādes paziņojumu lietojumprogrammas konfigurācija
  2. Lietotāju kartēšana pašpiegādes paziņojumiem
  3. Ierīces reģistrācija pašpiegādes paziņojumiem
  4. Pašpiegādes paziņojumu saņemšana ierīcēs
  5. Pašpiegādes paziņojumu mijiedarbības pārskati

Šajā diagrammā ir aprakstītas divas darbības, kas nepieciešamas, lai reģistrētu ierīces un lietotājus Customer Insights - Journeys.

Pašpiegādes paziņojumu ierīce un lietotāja reģistrācijas shēma.

Ierīces reģistrācija

Lai pabeigtu mobilās lietotnes konfigurēšanu, izstrādātājam ir jāreģistrē ierīces dažādos serveros. Jums jau ir jābūt ierīces marķierim, lietotāja ID no Customer Insights - Journeys (kontaktpersonas ID, interesenta ID, Customer Insights - Data profila ID) un mobilās lietojumprogrammas ID no Customer Insights - Journeys.

Pēc veiksmīga ierīces reģistrācijas pieprasījuma zvana tiek saņemta 202 atbilde. 202. gada atbildē tikai norādīts, ka pieprasījums ir pieņemts. Lai apstiprinātu veiksmīgu pieprasījumu, jums ir jāpārbauda statuss, izmantojot webhook vai tieši zvanot uz statusa galapunktu.

API

Ierīces reģistrācija (viena)

HTTP pieprasījuma paraugs (iOS):

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices

{
    "MobileAppId": "00000000-0000-0000-0000-000000000000",
    "UserId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "ApiToken": "%API_TOKEN%",
    "ApnsDeviceToken": "%APNS_TOKEN%"
}

HTTP pieprasījuma paraugs (Android):

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices

{
    "MobileAppId": "00000000-0000-0000-0000-000000000000",
    "UserId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "ApiToken": "%API_TOKEN%",
    "FcmDeviceToken": "%FCM_TOKEN%"
}

Galvenes:

  • x-ms-track-registration: ja tā ir patiesa, informācija par reģistrācijas panākumiem/neveiksmēm tiek saglabāta un ir pieejama, izmantojot reģistrācijas statusa API.
  • x-ms-callback-url: Ja neveiksmīga vai veiksmīga ierīces reģistrācija nav tukša, tā aktivizē POST pieprasījuma webhook.
  • x-ms-callback-url-headers: Satur serializētu JSON no virknes uz virkni vārdnīcas, kas attēlo galvenes, kas nodotas webhook pieprasījumiem. Izmanto tikai tad, ja ir definēts x-ms-callback-url.

Atgriešana: 202, ja iesniegtais pieprasījums ir derīgs, 400 citādi.

Atbildes orgāns:

Ja x-ms-track reģistrācija ir patiesa:

{
    "RegistrationRequestId": "%GUID%"
}

Pretējā gadījumā tukšs ķermenis.

Definīcijas
Nosaukums/vārds Apraksts
MobileAppId Konfigurēts Customer Insights - Journeys mobilās lietojumprogrammas identifikators.
Lietotāja ID Kontaktpersonas, interesenta vai Customer Insights - Data profila lietotāja identifikators no Customer Insights - Journeys.
ApiToken Jūsu API pilnvara, lai autorizētu pieprasījumu.
ApnsDeviceToken Lietojumprogrammas ģenerētais iOS unikālais ierīces marķiera identifikators. Tas tiks nosūtīts tikai ierīcei iOS
FcmDeviceToken Lietojumprogrammas ģenerētais Android unikālais ierīces marķiera identifikators. Tas tiks nosūtīts tikai ierīcei Android

Ierīces reģistrācija (vairākas)

Partijas reģistrācijas pamattekstā ir līdz pat 100 objektu masīvs, kas attēlo ierīces reģistrācijas pieprasījumus.

HTTP pieprasījuma paraugs (iOS):

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices/batch

[
    {
        "MobileAppId": "00000000-0000-0000-0000-000000000000",      
        "UserId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
        "ApiToken": "%API_TOKEN%",
        "ApnsDeviceToken": "%APNS_TOKEN%"
    },
    {
        "MobileAppId": "00000000-0000-0000-0000-000000000000",
        "UserId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
        "ApiToken": "%API_TOKEN%",
        "ApnsDeviceToken": "%APNS_TOKEN%"
    }
]

HTTP pieprasījuma paraugs (Android):

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices/batch

[
    {
        "MobileAppId": "00000000-0000-0000-0000-000000000000",      
        "UserId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
        "ApiToken": "%API_TOKEN%",
        "FcmDeviceToken": "%FCM_TOKEN%"
    },
    {
        "MobileAppId": "00000000-0000-0000-0000-000000000000",
        "UserId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
        "ApiToken": "%API_TOKEN%",
        "FcmDeviceToken": "%FCM_TOKEN%"
    }
]

Galvenes:

  • x-ms-track-registration: ja tā ir patiesa, informācija par reģistrācijas panākumiem vai neveiksmēm tiek saglabāta un ir pieejama, izmantojot reģistrācijas statusa API.
  • x-ms-callback-url: ja neveiksmīga vai veiksmīga ierīces reģistrācija nav tukša, tā aktivizē POST pieprasījuma webhook.
  • x-ms-callback-url-headers: satur serializētu JSON no virknes uz virkni vārdnīcas, kas attēlo galvenes, kas nodotas webhook pieprasījumiem. Izmanto tikai tad, kad x-ms-callback-url ir definēts.

Atgriešana: 202, ja iesniegtais pieprasījums ir derīgs, 400 citādi.

Atbildes orgāns:

Ja x-ms-track-registration ir patiess: krājumu masīvs, katrs krājumu pasūtījums atbilst pasūtījumam no pieprasījuma pamatteksta masīva.

[
    {
        "RegistrationRequestId": "%REG_REQUEST_ID%"
    },
    {
        "RegistrationRequestId": "%REG_REQUEST_ID%"
    }
]

Pretējā gadījumā tukšs ķermenis.

Ierīces reģistrācijas statuss

POST  {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices/status/

Pieprasījuma pamatteksts:

{
    "RegistrationRequestIds": [
        "%REG_REQUEST_ID%"
    ],
    "MobileAppId": "%MOBILE_APP_ID%",
    "ApiToken": "%API_TOKEN%"
}

Atgriešana: 200, ja iesniegtais pieprasījums ir derīgs, 400 citādi.

Atbildes ķermenis - priekšmetu masīvs:

[
    {
        "Status": "Pending|Success|Failed",
        "FailureReason": " DuplicateExists|DryRunSendingFailed|DeviceTokenTooLong|FailedToStoreDevice|ApiTokenNotValid " // dry run sending is a verification of device token by sending an invisible notification to mobile app. Such sending failure might happen due to a wrong device token or incorrect/expired mobile app auth data
    },
    {
        "Status": "Pending|Success|Failed",
        "FailureReason": " DuplicateExists|DryRunSendingFailed|DeviceTokenTooLong|FailedToStoreDevice|ApiTokenNotValid " // dry run sending is a verification of device token by sending an invisible notification to mobile app. Such sending failure might happen due to a wrong device token or incorrect/expired mobile app auth data
    }
]

Katrs krājuma pasūtījums atbilst pasūtījumam no RegistrationRequestIds masīva .

Definīcijas
Nosaukums/vārds Apraksts
RegistrationRequestIds Atsevišķu reģistrācijas pieprasījumu masīvs. Vērtības tiek ņemtas no reģistrācijas zvanu atbildes. Tas tiek nodrošināts tikai tad, ja reģistrācijai tika izmantota x-ms-track-registration galvene
MobileAppId Konfigurēts Customer Insights - Journeys mobilās lietojumprogrammas identifikators.
Lietotāja ID Kontaktpersonas, interesenta vai Customer Insights - Data profila lietotāja identifikators no Customer Insights - Journeys.

Svarīgi

Ir trīs iespējamie iemesli, kāpēc statuss var iestrēgt stāvoklī "Gaida":

  1. Sākotnējam ierīces reģistrācijas pieprasījumam bija nederīga API pilnvara. Lai nepieļautu, ka ļaunprātīgi dalībnieki veic DoS uzbrukumu videi, izsaucot "reģistrācijas ierīci" un radot bezgalīgu ierobežošanu, šādi mēģinājumi nerada reģistrācijas vēstures glabāšanu. Tāpēc nav informācijas, lai pārbaudītu panākumus.
  2. CRM vairākas stundas paliek ierobežotā stāvoklī, izraisot statusa atjaunināšanas operācijas kļūmi, izpildot savu darbu pēc vairākiem atkārtotiem mēģinājumiem.
  3. Ierīces reģistrācijas pieprasījums tika veikts, nenorādot x-ms-track-registration galveni.

Ierīces reģistrācijas statuss webhook

Ja ir norādīts x-ms-status-callback-url , vietrādis URL, kad ierīces reģistrācija ir veiksmīga vai neizdevās, Customer Insights - Journeys piekļūst galvenes vērtībai.

IZLIECIET ziņu vietrādī URL, kas norādīts ierīces reģistrācijas pieprasījuma x-ms-statusa-atzvanīšanas-URL galvenē.

Pamatteksts:

{ 
    "Status": "Success|Failed", 
    "Signature": "%SIGNATURE%", 
    "FailureReason": " DuplicateExists|DryRunSendingFailed|DeviceTokenTooLong|FailedToStoreDevice|ApiTokenNotValid" 
}

Padoms

Paraksts ir atzvanīšanas URL HMACSHA256 jaucējkods, kas aprēķināts, kā atslēgu izmantojot API marķieri. Izmantojiet vērtību, lai pārbaudītu, vai Customer Insights - Journeys zvans ir veikts. Jauciet atzvanīšanas URL ar API marķieri webhook pusē, izmantojot to pašu algoritmu un salīdzinot vērtības.

Piezīmes

Mēģinājums iesniegt pieprasījumu notiek vienu reizi. Ja pieprasījums netiek izpildīts, paziņojums tiek zaudēts. Kļūmju veidi ietver nepareizu atzvanīšanas URL, REST API zvana taimautu vai neparedzētas atbildes statusa kodu.

Atgriešana: 202, ja iesniegtais pieprasījums ir derīgs, 400 citādi.

Paredzamais ķermenis: tukšs ķermenis.

Ierīces tīrīšana (viena)

Ir svarīgi no datu bāzes noņemt ierīces, kas vairs nav derīgas, lai nodrošinātu efektīvu ziņojumu sūtīšanu. Izmantojiet tālāk norādīto pieeju, lai no ierīču tabulas noņemtu vecās ierīces, lietotāja un lietojumprogrammu kombinācijas.

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices/cleanup

{
    "MobileAppId": "00000000-0000-0000-0000-000000000000",
    "ApiToken": "%API_TOKEN%",
    "UserId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "DeviceToken": "%OPTIONAL_FCM_OR_APNS_DEVICE_TOKEN%"
}

Atgriešana: 202, ja iesniegtais pieprasījums ir derīgs, 400 citādi.

Definīcijas
Nosaukums/vārds Apraksts
MobileAppId Konfigurēts Customer Insights - Journeys mobilās lietojumprogrammas identifikators.
ApiToken Jūsu API pilnvara, lai autorizētu pieprasījumu.
Lietotāja ID Kontaktpersonas, interesenta vai Customer Insights - Data profila lietotāja identifikators no Customer Insights - Journeys.
DeviceToken Lietojumprogrammas ģenerētais unikālais ierīces marķiera identifikators.

Ierīces tīrīšana (vairākas)

Ir svarīgi no datu bāzes noņemt ierīces, kas vairs nav derīgas, lai nodrošinātu efektīvu ziņojumu sūtīšanu. Izmantojiet tālāk norādīto pieeju, lai no ierīču tabulas noņemtu vecās ierīces, lietotāja un lietojumprogrammu kombinācijas.

POST {PublicEndpoint}/api/v1.0/orgs/%ORG_ID%/pushdeviceregistration/devices/cleanup/batch

{
    "MobileAppId": "00000000-0000-0000-0000-000000000000",
    "ApiToken": "%API_TOKEN%",
    "UserId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "DeviceToken": "%OPTIONAL_FCM_OR_APNS_DEVICE_TOKEN%"
}

Atgriešana: 202, ja iesniegtais pieprasījums ir derīgs, 400 citādi.

Definīcijas
Nosaukums/vārds Apraksts
MobileAppId Konfigurēts Customer Insights - Journeys mobilās lietojumprogrammas identifikators.
ApiToken Jūsu API pilnvara, lai autorizētu pieprasījumu.
Lietotāja ID Kontaktpersonas, interesenta vai Customer Insights - Data profila lietotāja identifikators no Customer Insights - Journeys.
DeviceToken Lietojumprogrammas ģenerētais unikālais ierīces marķiera identifikators.