Documentation de l'API publique de la LNNTE

URL de base : https://public-api.lnnte-dncl.gc.ca

Authentification

• L'API nécessite l'utilisation d'une identification tierce pour votre application. Pour obtenir un jeton d'autorisation, utilisez le point final suivant: https://public-api.lnnte-dncl.gc.ca/OAuth/BearerToken
• La demande doit inclure: grant_type=client_credentials&client_id=12345&client_secret=12345
• En cas de succès, le corps de la réponse sera un objet JSON contenant une propriété « jeton_d'accès »
• Les demandes ultérieures à l'API doivent contenir un en-tête d'autorisation avec la valeur suivante : « Porteur {jeton_d'accès} » où vous remplacez le jeton d'accès par celui que vous avez obtenu.

Vérifier le numéro de téléphone

Point final

• Le point final pour vérifier un numéro de téléphone est : https://public-api.lnnte-dncl.gc.ca/v1/Consumer/Check
• La méthode REST à utiliser est POST

Demande

• La demande est un objet JSON contenant une propriété: « Téléphone » avec le numéro de téléphone non formaté comme valeur.

Réponse

La réponse est un objet JSON.

• Téléphone: le numéro de téléphone
• Ajouté à : la date et l'heure auxquelles le numéro de téléphone a été enregistré
• Mise à jour à : la dernière modification de cette inscription
• Actif: (Booléen)si ce numéro de téléphone est actuellement enregistré
• Actif à : la date et l'heure auxquelles l'enregistrement de ce numéro de téléphone est devenu actif
• Actif Maintenant: (Booléen)si ce numéro de téléphone est actuellement actif(la période d'attente de 31 jours est terminée)

Enregistrer le numéro de téléphone

Point final

• Le point final pour enregistrer un numéro de téléphone est : https://public-api.lnnte-dncl.gc.ca/v1/Consumer/Register
• La méthode REST à utiliser est POST

Demande

• La demande est un objet JSON contenant une propriété: « Téléphone » avec le numéro de téléphone non formaté comme valeur.

Réponse

La réponse est un objet JSON .

• Téléphone: le numéro de téléphone
• Ajouté à : la date et l'heure auxquelles le numéro de téléphone a été enregistré
• Mise à jour à : la dernière modification de cette inscription
• Actif: (Booléen)si ce numéro de téléphone est actuellement enregistré
• Actif à : la date et l'heure auxquelles l'enregistrement de ce numéro de téléphone est devenu actif
• Actif Maintenant: (Booléen)si ce numéro de téléphone est actuellement actif(la période d'attente de 31 jours est terminée)

Ajouter une plainte

Point final

• Le point final pour ajouter une plainte est : https://public-api.lnnte-dncl.gc.ca/v1/Consumer/Complaint
• La méthode REST à utiliser est POST

Demande

La demande est un objet JSON avec les propriétés suivantes :

• IncidentOccurredAt (date / heure *)
• OrgAgentPhone (chaîne de caractères) Numéro de téléphone qui a passé l'appel. Un des OrgAgentPhone ou OrgName doit être fourni
• CallerId (chaîne de caractères)Identification de l'appelant affichée
• OrgName (chaîne de caractères) Un des OrgAgentPhone ou OrgName doit être fourni
• OrgRepresented (chaîne de caractères)
• OrgIndustryID (uuid – voir le prochain point final de l'API)
• OrgIndustryOther (chaîne de caractères)
• OrgAddress (chaîne de caractères)
• OrgWebsite (chaîne de caractères)
• OrgEmail (chaîne de caractères)
• AdditionalInfo (chaîne de caractères)
• IncidentPhone (chaîne de caractères) Numéro de téléphone appelé
• IncidentPhoneProvider (chaîne de caractères) Opérateur téléphonique appelé
• IncidentPhoneIsPersonal (bool)
• IncidentPhoneIsBusiness (bool)
• ConsumerPhone1 (chaîne de caractères)
• ConsumerPhone2 (chaîne de caractères)
• ConsumerEmail (chaîne de caractères)
• ConsumerSalutation (chaîne de caractères)
• ConsumerFirstName (chaîne de caractères *)
• ConsumerLastName (chaîne de caractères *)
• ConsumerAddress
  • Country (chaîne de caractères *)
  • Province (chaîne de caractères)
  • City (chaîne de caractères *)
  • PostalCode (chaîne de caractères)
  • Line1 (chaîne de caractères *)
  • Line2 (chaîne de caractères)
• InteractionType (chaîne de caractères – un de suivants)
  • phone-live
  • phone-rec
  • phone-rec-hold-for-live
  • phone-fax-sound
  • phone-nobody-online
  • phone-not-answered
  • phone-voice-mail
  • fax
• ConsumerLanguage (chaîne de caractères “en” or “fr”)
• CallObjectives (tableau)
  • Type (chaîne de caractères – un des suivants)
    • sell
    • win
    • survey
    • political
    • donation
    • debt-bill-collector
    • public-service-info-msg
    • appointment
    • overdue
    • unknown
  • Details (chaîne de caractères)
• PreviousInteractions (tableau de chaînes de caractères – dans ce qui suit)
  • purchase-during-call
  • purchase-within-18m
  • purchase-morethan-18m
  • asked-about-product
  • contract-expired
  • personal-info-provided
  • service-estimate
• CallInterdictionRequests (tableau de chaînes de caractères – dans ce qui suit)
  • during-call
  • prev-14d
  • prev-refused

Réponse

La réponse est un objet JSON .

• Id (chaînes de caractères) – Usage interne uniquement
• Reference (chaînes de caractères) – Numéro de référence attribué à cette plainte
• AddedAt (date / heure)
• AddedByChannelId (chaînes de caractères) – Usage interne uniquement

Obtenez des industries

Point final

• Le point final pour obtenir la liste des industries est : https://public-api.lnnte-dncl.gc.ca/v1/DynamicData/Industries
• La méthode REST à utiliser est GET

Demande

• La demande est vide

Réponse

Le corps de la réponse est un tableau JSON .

• Id (chaînes de caractères) – l'uuid à utiliser lors du dépôt d'une plainte
• Name (chaînes de caractères) – le nom de l’industrie