Identity Verification and Message Engagement Registration

Wrapper for various Identity Verification services and Message Engagement Platforms

Télécharger la spécification OpenAPI

Identities

APIs relating to working with Identities

Opérations disponibles

Retrieve all of the identities associated with your account.

List identities

gethttps://api.nexmo.com/v1/messaging-engagement/identities

Réponses
Type de contenu
application/json

List of brands that are associated with an account

page_size
integer
exemple10

Items per page

page
integer
Min1
exemple2

Page Offset

total_pages
integer
Min1
exemple100

Number of pages in the entire result set

total_items
integer
exemple100

Number of items in the entire result set

_embedded
object
brands
array
entity_type
string
exemplePUBLIC_PROFIT
Il doit s'agir de l'un d'entre eux :INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exempleVonage
company_name
string
exempleVonage
ein
string
exemple20-1111111
alt_business_id_type
string
exempleDUNS
alt_business_id
string
exemple150483782
phone
string
exemple+15556660001
street
string
exemple23 Main Street
city
string
exempleHolmdel
state
string
exempleNJ
postal_code
string
exemple07733
country
string
exempleUS
email
string
exempledevrel@vonage.com
stock_symbol
string
exempleVG
stock_exchange
string
exempleNASDAQ
website
string
exemplehttps://vonage.com
brand_relationship
string
exempleKEY_ACCOUNT
Il doit s'agir de l'un d'entre eux :BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exempleTECHNOLOGY
identity_id
string
exempleBLQKOPK

Identity ID associated with a number

created_date
string
exemple2020-01-02 05:12:14
last_updated
string
exemple2020-02-02 14:12:00
_links
object
self
object
href
string
exemplehttps://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK
engagements
object
href
string
exemplehttps://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK

Exemple Réponse

{
   "page_size": 10,
   "page": 2,
   "total_pages": 100,
   "total_items": 100,
   "_embedded": {
      "brands": [
         {
            "entity_type": "PUBLIC_PROFIT",
            "display_name": "Vonage",
            "company_name": "Vonage",
            "ein": "20-1111111",
            "alt_business_id_type": "DUNS",
            "alt_business_id": "150483782",
            "phone": "+15556660001",
            "street": "23 Main Street",
            "city": "Holmdel",
            "state": "NJ",
            "postal_code": "07733",
            "country": "US",
            "email": "devrel@vonage.com",
            "stock_symbol": "VG",
            "stock_exchange": "NASDAQ",
            "website": "https://vonage.com",
            "brand_relationship": "KEY_ACCOUNT",
            "vertical": "TECHNOLOGY",
            "identity_id": "BLQKOPK",
            "created_date": "2020-01-02 05:12:14",
            "last_updated": "2020-02-02 14:12:00",
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK"
               },
               "engagements": {
                  "href": "https://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK"
               }
            }
         }
      ]
   }
}

Create a new identity for your account

Create a new identity for your account. Most accounts will be created immediately, and you can move on to qualifying a new engagement for the identity. Some brands may require additional vetting. In such cases, please move on to the vetting API endpoints before attempting to create an engagement.

Please note the entity_type field, as that field value will help determine which fields are required.

posthttps://api.nexmo.com/v1/messaging-engagement/identities

Corps de la demande
Type de contenu
application/json

L'un des
entity_type
string
Exigée
exemplePUBLIC_PROFIT
Il doit s'agir de l'un d'entre eux :INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
Exigée
exempleVonage
company_name
string
exempleVonage
ein
string
exemple20-1111111
alt_business_id_type
string
exempleDUNS
alt_business_id
string
exemple150483782
phone
string
Exigée
exemple+15556660001
street
string
exemple23 Main Street
city
string
exempleHolmdel
state
string
exempleNJ
postal_code
string
exemple07733
country
string
Exigée
exempleUS
email
string
Exigée
exempledevrel@vonage.com
stock_symbol
string
exempleVG
stock_exchange
string
exempleNASDAQ
website
string
exemplehttps://vonage.com
brand_relationship
string
Exigée
exempleKEY_ACCOUNT
Il doit s'agir de l'un d'entre eux :BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exempleTECHNOLOGY

Exemple Demande

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "company_name": "Vonage",
   "ein": "20-1111111",
   "alt_business_id_type": "DUNS",
   "alt_business_id": "150483782",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "website": "https://vonage.com",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY"
}

Réponses
Type de contenu
application/json

Return a single identity

entity_type
string
exemplePUBLIC_PROFIT
Il doit s'agir de l'un d'entre eux :INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exempleVonage
company_name
string
exempleVonage
ein
string
exemple20-1111111
alt_business_id_type
string
exempleDUNS
alt_business_id
string
exemple150483782
phone
string
exemple+15556660001
street
string
exemple23 Main Street
city
string
exempleHolmdel
state
string
exempleNJ
postal_code
string
exemple07733
country
string
exempleUS
email
string
exempledevrel@vonage.com
stock_symbol
string
exempleVG
stock_exchange
string
exempleNASDAQ
website
string
exemplehttps://vonage.com
brand_relationship
string
exempleKEY_ACCOUNT
Il doit s'agir de l'un d'entre eux :BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exempleTECHNOLOGY
identity_id
string
exempleBLQKOPK

Identity ID associated with a number

created_date
string
exemple2020-01-02 05:12:14
last_updated
string
exemple2020-02-02 14:12:00
_links
object
self
object
href
string
exemple[ "https://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK", "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c" ]
engagements
object
href
string
exemplehttps://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK

Exemple Réponse

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "company_name": "Vonage",
   "ein": "20-1111111",
   "alt_business_id_type": "DUNS",
   "alt_business_id": "150483782",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "website": "https://vonage.com",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY",
   "identity_id": "BLQKOPK",
   "created_date": "2020-01-02 05:12:14",
   "last_updated": "2020-02-02 14:12:00",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c"
      },
      "engagements": {
         "href": "https://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK"
      }
   }
}

Retrieve a specific identity

Get an identity

gethttps://api.nexmo.com/v1/messaging-engagement/identities/:identity_id

Trajectoire Paramètres

identity_id
string
Exigée
exempleBLQKOPK

Identity ID associated with a number

Réponses
Type de contenu
application/json

Return a single identity

entity_type
string
exemplePUBLIC_PROFIT
Il doit s'agir de l'un d'entre eux :INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exempleVonage
company_name
string
exempleVonage
ein
string
exemple20-1111111
alt_business_id_type
string
exempleDUNS
alt_business_id
string
exemple150483782
phone
string
exemple+15556660001
street
string
exemple23 Main Street
city
string
exempleHolmdel
state
string
exempleNJ
postal_code
string
exemple07733
country
string
exempleUS
email
string
exempledevrel@vonage.com
stock_symbol
string
exempleVG
stock_exchange
string
exempleNASDAQ
website
string
exemplehttps://vonage.com
brand_relationship
string
exempleKEY_ACCOUNT
Il doit s'agir de l'un d'entre eux :BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exempleTECHNOLOGY
identity_id
string
exempleBLQKOPK

Identity ID associated with a number

created_date
string
exemple2020-01-02 05:12:14
last_updated
string
exemple2020-02-02 14:12:00
_links
object
self
object
href
string
exemple[ "https://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK", "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c" ]
engagements
object
href
string
exemplehttps://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK

Exemple Réponse

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "company_name": "Vonage",
   "ein": "20-1111111",
   "alt_business_id_type": "DUNS",
   "alt_business_id": "150483782",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "website": "https://vonage.com",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY",
   "identity_id": "BLQKOPK",
   "created_date": "2020-01-02 05:12:14",
   "last_updated": "2020-02-02 14:12:00",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c"
      },
      "engagements": {
         "href": "https://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK"
      }
   }
}

Partially update a specific identity

Partial update of an identity

patchhttps://api.nexmo.com/v1/messaging-engagement/identities/:identity_id

Trajectoire Paramètres

identity_id
string
Exigée
exempleBLQKOPK

Identity ID associated with a number

Corps de la demande
Type de contenu
application/json

entity_type
string
exemplePUBLIC_PROFIT
Il doit s'agir de l'un d'entre eux :INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exempleVonage
website
string
exemplehttps://vonage.com
phone
string
exemple+15556660001
street
string
exemple23 Main Street
city
string
exempleHolmdel
state
string
exempleNJ
postal_code
string
exemple07733
country
string
exempleUS
email
string
exempledevrel@vonage.com
stock_symbol
string
exempleVG
stock_exchange
string
exempleNASDAQ
brand_relationship
string
exempleKEY_ACCOUNT
vertical
string
exempleTECHNOLOGY

Exemple Demande

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "website": "https://vonage.com",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY"
}

Réponses
Type de contenu
application/json

Return a single identity

entity_type
string
exemplePUBLIC_PROFIT
Il doit s'agir de l'un d'entre eux :INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exempleVonage
company_name
string
exempleVonage
ein
string
exemple20-1111111
alt_business_id_type
string
exempleDUNS
alt_business_id
string
exemple150483782
phone
string
exemple+15556660001
street
string
exemple23 Main Street
city
string
exempleHolmdel
state
string
exempleNJ
postal_code
string
exemple07733
country
string
exempleUS
email
string
exempledevrel@vonage.com
stock_symbol
string
exempleVG
stock_exchange
string
exempleNASDAQ
website
string
exemplehttps://vonage.com
brand_relationship
string
exempleKEY_ACCOUNT
Il doit s'agir de l'un d'entre eux :BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exempleTECHNOLOGY
identity_id
string
exempleBLQKOPK

Identity ID associated with a number

created_date
string
exemple2020-01-02 05:12:14
last_updated
string
exemple2020-02-02 14:12:00
_links
object
self
object
href
string
exemple[ "https://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK", "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c" ]
engagements
object
href
string
exemplehttps://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK

Exemple Réponse

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "company_name": "Vonage",
   "ein": "20-1111111",
   "alt_business_id_type": "DUNS",
   "alt_business_id": "150483782",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "website": "https://vonage.com",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY",
   "identity_id": "BLQKOPK",
   "created_date": "2020-01-02 05:12:14",
   "last_updated": "2020-02-02 14:12:00",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c"
      },
      "engagements": {
         "href": "https://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK"
      }
   }
}

Update a specific identity

Update an identity

puthttps://api.nexmo.com/v1/messaging-engagement/identities/:identity_id

Trajectoire Paramètres

identity_id
string
Exigée
exempleBLQKOPK

Identity ID associated with a number

Corps de la demande
Type de contenu
application/json

entity_type
string
exemplePUBLIC_PROFIT
Il doit s'agir de l'un d'entre eux :INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exempleVonage
website
string
exemplehttps://vonage.com
phone
string
exemple+15556660001
street
string
exemple23 Main Street
city
string
exempleHolmdel
state
string
exempleNJ
postal_code
string
exemple07733
country
string
exempleUS
email
string
exempledevrel@vonage.com
stock_symbol
string
exempleVG
stock_exchange
string
exempleNASDAQ
brand_relationship
string
exempleKEY_ACCOUNT
vertical
string
exempleTECHNOLOGY

Exemple Demande

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "website": "https://vonage.com",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY"
}

Réponses
Type de contenu
application/json

Return a single identity

entity_type
string
exemplePUBLIC_PROFIT
Il doit s'agir de l'un d'entre eux :INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exempleVonage
company_name
string
exempleVonage
ein
string
exemple20-1111111
alt_business_id_type
string
exempleDUNS
alt_business_id
string
exemple150483782
phone
string
exemple+15556660001
street
string
exemple23 Main Street
city
string
exempleHolmdel
state
string
exempleNJ
postal_code
string
exemple07733
country
string
exempleUS
email
string
exempledevrel@vonage.com
stock_symbol
string
exempleVG
stock_exchange
string
exempleNASDAQ
website
string
exemplehttps://vonage.com
brand_relationship
string
exempleKEY_ACCOUNT
Il doit s'agir de l'un d'entre eux :BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exempleTECHNOLOGY
identity_id
string
exempleBLQKOPK

Identity ID associated with a number

created_date
string
exemple2020-01-02 05:12:14
last_updated
string
exemple2020-02-02 14:12:00
_links
object
self
object
href
string
exemple[ "https://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK", "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c" ]
engagements
object
href
string
exemplehttps://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK

Exemple Réponse

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "company_name": "Vonage",
   "ein": "20-1111111",
   "alt_business_id_type": "DUNS",
   "alt_business_id": "150483782",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "website": "https://vonage.com",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY",
   "identity_id": "BLQKOPK",
   "created_date": "2020-01-02 05:12:14",
   "last_updated": "2020-02-02 14:12:00",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c"
      },
      "engagements": {
         "href": "https://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK"
      }
   }
}

Remove a specific identity from your account

Delete an identity

deletehttps://api.nexmo.com/v1/messaging-engagement/identities/:identity_id

Trajectoire Paramètres

identity_id
string
Exigée
exempleBLQKOPK

Identity ID associated with a number

Réponses

No content

Engagements

APIs relating to working with Engagements

Opérations disponibles

Retrieve all of the engagements

List engagements

gethttps://api.nexmo.com/v1/messaging-engagement/engagements

Réponses
Type de contenu
application/json

List of engagements that are associated with an identity

page_size
integer
exemple10

Items per page

page
integer
Min1
exemple2

Page Offset

total_pages
integer
Min1
exemple100

Number of pages in the entire result set

total_items
integer
exemple100

Number of items in the entire result set

_embedded
object
brands
array
identity_id
string
exempleBLQKOPK

Identity ID associated with a number

vertical
string
exempleTECHNOLOGY
use_case
string
exempleACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplestring
description
string
exempleUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exempletrue
direct_lending
boolean
exempletrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exempleSample Message
sample_two
string
exempleAdditional Sample Message
sample_three
string
exempleAdditional Sample Message
sample_four
string
exempleAdditional Sample Message
message_flow
string
exemplestring
help_message
string
exemplestring
affiliate_marketing
boolean
exempletrue
engagement_id
string
exempleC1DEB879

ID associated with a specific engagement

created_date
string
last_updated
string
_links
object
self
object
href
string
numbers
object
href
string

Exemple Réponse

{
   "page_size": 10,
   "page": 2,
   "total_pages": 100,
   "total_items": 100,
   "_embedded": {
      "brands": [
         {
            "identity_id": "BLQKOPK",
            "vertical": "TECHNOLOGY",
            "use_case": "ACCOUNT_NOTIFICATION",
            "sub_use_cases": [
               "2FA",
               "SECURITY_ALERT"
            ],
            "reseller_id": "string",
            "description": "User notifications",
            "embedded_link": false,
            "embedded_phone": false,
            "number_pool": false,
            "age_gated": true,
            "direct_lending": true,
            "subscriber_optin": false,
            "subscriber_optout": false,
            "subscriber_help": false,
            "sample_one": "Sample Message",
            "sample_two": "Additional Sample Message",
            "sample_three": "Additional Sample Message",
            "sample_four": "Additional Sample Message",
            "message_flow": "string",
            "help_message": "string",
            "affiliate_marketing": true,
            "engagement_id": "C1DEB879",
            "created_date": "string",
            "last_updated": "string",
            "_links": {
               "self": {
                  "href": "string"
               },
               "numbers": {
                  "href": "string"
               }
            }
         }
      ]
   }
}

Add a new engagement to an identity

Create Engagement

posthttps://api.nexmo.com/v1/messaging-engagement/engagements

Corps de la demande
Type de contenu
application/json

identity_id
string
Exigée
exempleBLQKOPK

Identity ID associated with a number

vertical
string
Exigée
exempleTECHNOLOGY
use_case
string
Exigée
exempleACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplestring
description
string
Exigée
exempleUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exempletrue
direct_lending
boolean
exempletrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exempleSample Message
sample_two
string
exempleAdditional Sample Message
sample_three
string
exempleAdditional Sample Message
sample_four
string
exempleAdditional Sample Message
message_flow
string
exemplestring
help_message
string
exemplestring
affiliate_marketing
boolean
exempletrue

Exemple Demande

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true
}

Réponses
Type de contenu
application/json

Return a single engagement

identity_id
string
exempleBLQKOPK

Identity ID associated with a number

vertical
string
exempleTECHNOLOGY
use_case
string
exempleACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplestring
description
string
exempleUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exempletrue
direct_lending
boolean
exempletrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exempleSample Message
sample_two
string
exempleAdditional Sample Message
sample_three
string
exempleAdditional Sample Message
sample_four
string
exempleAdditional Sample Message
message_flow
string
exemplestring
help_message
string
exemplestring
affiliate_marketing
boolean
exempletrue
engagement_id
string
exempleC1DEB879

ID associated with a specific engagement

created_date
string
last_updated
string
_links
object
self
object
href
string
exemple/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab
numbers
object
href
string

Exemple Réponse

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true,
   "engagement_id": "C1DEB879",
   "created_date": "string",
   "last_updated": "string",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab"
      },
      "numbers": {
         "href": "string"
      }
   }
}

Retrieve a specific engagement

Get an engagement

gethttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id

Trajectoire Paramètres

engagement_id
string
Exigée
exempleC1DEB879

ID associated with a specific engagement

Réponses
Type de contenu
application/json

Return a single engagement

identity_id
string
exempleBLQKOPK

Identity ID associated with a number

vertical
string
exempleTECHNOLOGY
use_case
string
exempleACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplestring
description
string
exempleUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exempletrue
direct_lending
boolean
exempletrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exempleSample Message
sample_two
string
exempleAdditional Sample Message
sample_three
string
exempleAdditional Sample Message
sample_four
string
exempleAdditional Sample Message
message_flow
string
exemplestring
help_message
string
exemplestring
affiliate_marketing
boolean
exempletrue
engagement_id
string
exempleC1DEB879

ID associated with a specific engagement

created_date
string
last_updated
string
_links
object
self
object
href
string
exemple/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab
numbers
object
href
string

Exemple Réponse

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true,
   "engagement_id": "C1DEB879",
   "created_date": "string",
   "last_updated": "string",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab"
      },
      "numbers": {
         "href": "string"
      }
   }
}

Partially update a specific engagement

Partial update of an engagement

patchhttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id

Trajectoire Paramètres

engagement_id
string
Exigée
exempleC1DEB879

ID associated with a specific engagement

Corps de la demande
Type de contenu
application/json

identity_id
string
exempleBLQKOPK

Identity ID associated with a number

vertical
string
exempleTECHNOLOGY
use_case
string
exempleACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplestring
description
string
exempleUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exempletrue
direct_lending
boolean
exempletrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exempleSample Message
sample_two
string
exempleAdditional Sample Message
sample_three
string
exempleAdditional Sample Message
sample_four
string
exempleAdditional Sample Message
message_flow
string
exemplestring
help_message
string
exemplestring
affiliate_marketing
boolean
exempletrue

Exemple Demande

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true
}

Réponses
Type de contenu
application/json

Return a single engagement

identity_id
string
exempleBLQKOPK

Identity ID associated with a number

vertical
string
exempleTECHNOLOGY
use_case
string
exempleACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplestring
description
string
exempleUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exempletrue
direct_lending
boolean
exempletrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exempleSample Message
sample_two
string
exempleAdditional Sample Message
sample_three
string
exempleAdditional Sample Message
sample_four
string
exempleAdditional Sample Message
message_flow
string
exemplestring
help_message
string
exemplestring
affiliate_marketing
boolean
exempletrue
engagement_id
string
exempleC1DEB879

ID associated with a specific engagement

created_date
string
last_updated
string
_links
object
self
object
href
string
exemple/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab
numbers
object
href
string

Exemple Réponse

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true,
   "engagement_id": "C1DEB879",
   "created_date": "string",
   "last_updated": "string",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab"
      },
      "numbers": {
         "href": "string"
      }
   }
}

Update a specific engagement

Update an engagement

puthttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id

Trajectoire Paramètres

engagement_id
string
Exigée
exempleC1DEB879

ID associated with a specific engagement

Corps de la demande
Type de contenu
application/json

identity_id
string
exempleBLQKOPK

Identity ID associated with a number

vertical
string
exempleTECHNOLOGY
use_case
string
exempleACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplestring
description
string
exempleUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exempletrue
direct_lending
boolean
exempletrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exempleSample Message
sample_two
string
exempleAdditional Sample Message
sample_three
string
exempleAdditional Sample Message
sample_four
string
exempleAdditional Sample Message
message_flow
string
exemplestring
help_message
string
exemplestring
affiliate_marketing
boolean
exempletrue

Exemple Demande

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true
}

Réponses
Type de contenu
application/json

Return a single engagement

identity_id
string
exempleBLQKOPK

Identity ID associated with a number

vertical
string
exempleTECHNOLOGY
use_case
string
exempleACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplestring
description
string
exempleUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exempletrue
direct_lending
boolean
exempletrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exempleSample Message
sample_two
string
exempleAdditional Sample Message
sample_three
string
exempleAdditional Sample Message
sample_four
string
exempleAdditional Sample Message
message_flow
string
exemplestring
help_message
string
exemplestring
affiliate_marketing
boolean
exempletrue
engagement_id
string
exempleC1DEB879

ID associated with a specific engagement

created_date
string
last_updated
string
_links
object
self
object
href
string
exemple/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab
numbers
object
href
string

Exemple Réponse

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true,
   "engagement_id": "C1DEB879",
   "created_date": "string",
   "last_updated": "string",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab"
      },
      "numbers": {
         "href": "string"
      }
   }
}

Stop a specific engagement on an identity

Stop an engagement

deletehttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id

Trajectoire Paramètres

engagement_id
string
Exigée
exempleC1DEB879

ID associated with a specific engagement

Réponses

No content

Numbers

APIs relating to working with Numbers in Engagements

Opérations disponibles

Retrieve Numbers associated with an engagement

Get numbers in engagement

gethttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id/numbers

Trajectoire Paramètres

engagement_id
string
Exigée
exempleC1DEB879

ID associated with a specific engagement

Réponses
Type de contenu
application/json

List of numbers that are associated with an engagement

page_size
integer
exemple10

Items per page

page
integer
Min1
exemple2

Page Offset

total_pages
integer
Min1
exemple100

Number of pages in the entire result set

total_items
integer
exemple100

Number of items in the entire result set

_embedded
object
numbers
array
_links
object
engagement
object
href
string
exemple{ "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/" }

Exemple Réponse

{
   "page_size": 10,
   "page": 2,
   "total_pages": 100,
   "total_items": 100,
   "_embedded": {
      "numbers": [
         "15556660001",
         "15556660002"
      ],
      "_links": {
         "engagement": {
            "href": {
               "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/"
            }
         }
      }
   }
}

Add numbers to an engagement

Adds a series of numbers from an engagement. This endpoint supports partial successes. If a request is partially successful, the response code will be 207 and details can be found in the response body.

If all items succeed, you will receive a 200. If all items fail, you will receive a 400.

posthttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id/numbers

Trajectoire Paramètres

engagement_id
string
Exigée
exempleC1DEB879

ID associated with a specific engagement

Corps de la demande
Type de contenu
application/json

numbers
array
Exigée

Exemple Demande

{
   "numbers": [
      "15556660001",
      "15556660002"
   ]
}

Réponses
Type de contenu
application/json

Successful bulk operation

numbers
array
_links
object
engagement
object
href
string
exemple{ "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/" }

Exemple Réponse

{
   "numbers": [
      "15556660001",
      "15556660002"
   ],
   "_links": {
      "engagement": {
         "href": {
            "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/"
         }
      }
   }
}

Remove a series of number from an engagement

Remove a series of numbers from an engagement. This endpoint supports partial successes. If a request is partially successful, the response code will be 207 and details can be found in the response body.

If all items succeed, you will receive a 200. If all items fail, you will receive a 400.

posthttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id/numbers/delete

Trajectoire Paramètres

engagement_id
string
Exigée
exempleC1DEB879

ID associated with a specific engagement

Corps de la demande
Type de contenu
application/json

numbers
array
Exigée

Exemple Demande

{
   "numbers": [
      "15556660001",
      "15556660002"
   ]
}

Réponses
Type de contenu
application/json

Successful bulk operation

numbers
array
_links
object
engagement
object
href
string
exemple{ "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/" }

Exemple Réponse

{
   "numbers": [
      "15556660001",
      "15556660002"
   ],
   "_links": {
      "engagement": {
         "href": {
            "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/"
         }
      }
   }
}