Identity Verification and Message Engagement Registration

Wrapper for various Identity Verification services and Message Engagement Platforms

OpenAPI-Spezifikation herunterladen

Identities

APIs relating to working with Identities

Verfügbare Operationen

Retrieve all of the identities associated with your account.

List identities

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

Antworten
Inhalt Typ
application/json

List of brands that are associated with an account

page_size
integer
Beispiel10

Items per page

page
integer
Min1
Beispiel2

Page Offset

total_pages
integer
Min1
Beispiel100

Number of pages in the entire result set

total_items
integer
Beispiel100

Number of items in the entire result set

_embedded
object
brands
array
entity_type
string
BeispielPUBLIC_PROFIT
Muss eines der folgenden sein:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
BeispielVonage
company_name
string
BeispielVonage
ein
string
Beispiel20-1111111
alt_business_id_type
string
BeispielDUNS
alt_business_id
string
Beispiel150483782
phone
string
Beispiel+15556660001
street
string
Beispiel23 Main Street
city
string
BeispielHolmdel
state
string
BeispielNJ
postal_code
string
Beispiel07733
country
string
BeispielUS
email
string
Beispieldevrel@vonage.com
stock_symbol
string
BeispielVG
stock_exchange
string
BeispielNASDAQ
website
string
Beispielhttps://vonage.com
brand_relationship
string
BeispielKEY_ACCOUNT
Muss eines der folgenden sein:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
BeispielTECHNOLOGY
identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

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

Beispiel Antwort

{
   "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

Anfrage Körper
Inhalt Typ
application/json

Einer der
entity_type
string
Erforderlich
BeispielPUBLIC_PROFIT
Muss eines der folgenden sein:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
Erforderlich
BeispielVonage
company_name
string
BeispielVonage
ein
string
Beispiel20-1111111
alt_business_id_type
string
BeispielDUNS
alt_business_id
string
Beispiel150483782
phone
string
Erforderlich
Beispiel+15556660001
street
string
Beispiel23 Main Street
city
string
BeispielHolmdel
state
string
BeispielNJ
postal_code
string
Beispiel07733
country
string
Erforderlich
BeispielUS
email
string
Erforderlich
Beispieldevrel@vonage.com
stock_symbol
string
BeispielVG
stock_exchange
string
BeispielNASDAQ
website
string
Beispielhttps://vonage.com
brand_relationship
string
Erforderlich
BeispielKEY_ACCOUNT
Muss eines der folgenden sein:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
BeispielTECHNOLOGY

Beispiel Anfrage

{
   "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"
}

Antworten
Inhalt Typ
application/json

Return a single identity

entity_type
string
BeispielPUBLIC_PROFIT
Muss eines der folgenden sein:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
BeispielVonage
company_name
string
BeispielVonage
ein
string
Beispiel20-1111111
alt_business_id_type
string
BeispielDUNS
alt_business_id
string
Beispiel150483782
phone
string
Beispiel+15556660001
street
string
Beispiel23 Main Street
city
string
BeispielHolmdel
state
string
BeispielNJ
postal_code
string
Beispiel07733
country
string
BeispielUS
email
string
Beispieldevrel@vonage.com
stock_symbol
string
BeispielVG
stock_exchange
string
BeispielNASDAQ
website
string
Beispielhttps://vonage.com
brand_relationship
string
BeispielKEY_ACCOUNT
Muss eines der folgenden sein:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
BeispielTECHNOLOGY
identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

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

Beispiel Antwort

{
   "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

Pfad Parameter

identity_id
string
Erforderlich
BeispielBLQKOPK

Identity ID associated with a number

Antworten
Inhalt Typ
application/json

Return a single identity

entity_type
string
BeispielPUBLIC_PROFIT
Muss eines der folgenden sein:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
BeispielVonage
company_name
string
BeispielVonage
ein
string
Beispiel20-1111111
alt_business_id_type
string
BeispielDUNS
alt_business_id
string
Beispiel150483782
phone
string
Beispiel+15556660001
street
string
Beispiel23 Main Street
city
string
BeispielHolmdel
state
string
BeispielNJ
postal_code
string
Beispiel07733
country
string
BeispielUS
email
string
Beispieldevrel@vonage.com
stock_symbol
string
BeispielVG
stock_exchange
string
BeispielNASDAQ
website
string
Beispielhttps://vonage.com
brand_relationship
string
BeispielKEY_ACCOUNT
Muss eines der folgenden sein:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
BeispielTECHNOLOGY
identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

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

Beispiel Antwort

{
   "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

Pfad Parameter

identity_id
string
Erforderlich
BeispielBLQKOPK

Identity ID associated with a number

Anfrage Körper
Inhalt Typ
application/json

entity_type
string
BeispielPUBLIC_PROFIT
Muss eines der folgenden sein:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
BeispielVonage
website
string
Beispielhttps://vonage.com
phone
string
Beispiel+15556660001
street
string
Beispiel23 Main Street
city
string
BeispielHolmdel
state
string
BeispielNJ
postal_code
string
Beispiel07733
country
string
BeispielUS
email
string
Beispieldevrel@vonage.com
stock_symbol
string
BeispielVG
stock_exchange
string
BeispielNASDAQ
brand_relationship
string
BeispielKEY_ACCOUNT
vertical
string
BeispielTECHNOLOGY

Beispiel Anfrage

{
   "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"
}

Antworten
Inhalt Typ
application/json

Return a single identity

entity_type
string
BeispielPUBLIC_PROFIT
Muss eines der folgenden sein:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
BeispielVonage
company_name
string
BeispielVonage
ein
string
Beispiel20-1111111
alt_business_id_type
string
BeispielDUNS
alt_business_id
string
Beispiel150483782
phone
string
Beispiel+15556660001
street
string
Beispiel23 Main Street
city
string
BeispielHolmdel
state
string
BeispielNJ
postal_code
string
Beispiel07733
country
string
BeispielUS
email
string
Beispieldevrel@vonage.com
stock_symbol
string
BeispielVG
stock_exchange
string
BeispielNASDAQ
website
string
Beispielhttps://vonage.com
brand_relationship
string
BeispielKEY_ACCOUNT
Muss eines der folgenden sein:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
BeispielTECHNOLOGY
identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

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

Beispiel Antwort

{
   "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

Pfad Parameter

identity_id
string
Erforderlich
BeispielBLQKOPK

Identity ID associated with a number

Anfrage Körper
Inhalt Typ
application/json

entity_type
string
BeispielPUBLIC_PROFIT
Muss eines der folgenden sein:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
BeispielVonage
website
string
Beispielhttps://vonage.com
phone
string
Beispiel+15556660001
street
string
Beispiel23 Main Street
city
string
BeispielHolmdel
state
string
BeispielNJ
postal_code
string
Beispiel07733
country
string
BeispielUS
email
string
Beispieldevrel@vonage.com
stock_symbol
string
BeispielVG
stock_exchange
string
BeispielNASDAQ
brand_relationship
string
BeispielKEY_ACCOUNT
vertical
string
BeispielTECHNOLOGY

Beispiel Anfrage

{
   "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"
}

Antworten
Inhalt Typ
application/json

Return a single identity

entity_type
string
BeispielPUBLIC_PROFIT
Muss eines der folgenden sein:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
BeispielVonage
company_name
string
BeispielVonage
ein
string
Beispiel20-1111111
alt_business_id_type
string
BeispielDUNS
alt_business_id
string
Beispiel150483782
phone
string
Beispiel+15556660001
street
string
Beispiel23 Main Street
city
string
BeispielHolmdel
state
string
BeispielNJ
postal_code
string
Beispiel07733
country
string
BeispielUS
email
string
Beispieldevrel@vonage.com
stock_symbol
string
BeispielVG
stock_exchange
string
BeispielNASDAQ
website
string
Beispielhttps://vonage.com
brand_relationship
string
BeispielKEY_ACCOUNT
Muss eines der folgenden sein:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
BeispielTECHNOLOGY
identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

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

Beispiel Antwort

{
   "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

Pfad Parameter

identity_id
string
Erforderlich
BeispielBLQKOPK

Identity ID associated with a number

Antworten

No content

Engagements

APIs relating to working with Engagements

Verfügbare Operationen

Retrieve all of the engagements

List engagements

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

Antworten
Inhalt Typ
application/json

List of engagements that are associated with an identity

page_size
integer
Beispiel10

Items per page

page
integer
Min1
Beispiel2

Page Offset

total_pages
integer
Min1
Beispiel100

Number of pages in the entire result set

total_items
integer
Beispiel100

Number of items in the entire result set

_embedded
object
brands
array
identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

vertical
string
BeispielTECHNOLOGY
use_case
string
BeispielACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
Beispielstring
description
string
BeispielUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
Beispieltrue
direct_lending
boolean
Beispieltrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
BeispielSample Message
sample_two
string
BeispielAdditional Sample Message
sample_three
string
BeispielAdditional Sample Message
sample_four
string
BeispielAdditional Sample Message
message_flow
string
Beispielstring
help_message
string
Beispielstring
affiliate_marketing
boolean
Beispieltrue
engagement_id
string
BeispielC1DEB879

ID associated with a specific engagement

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

Beispiel Antwort

{
   "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

Anfrage Körper
Inhalt Typ
application/json

identity_id
string
Erforderlich
BeispielBLQKOPK

Identity ID associated with a number

vertical
string
Erforderlich
BeispielTECHNOLOGY
use_case
string
Erforderlich
BeispielACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
Beispielstring
description
string
Erforderlich
BeispielUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
Beispieltrue
direct_lending
boolean
Beispieltrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
BeispielSample Message
sample_two
string
BeispielAdditional Sample Message
sample_three
string
BeispielAdditional Sample Message
sample_four
string
BeispielAdditional Sample Message
message_flow
string
Beispielstring
help_message
string
Beispielstring
affiliate_marketing
boolean
Beispieltrue

Beispiel Anfrage

{
   "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
}

Antworten
Inhalt Typ
application/json

Return a single engagement

identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

vertical
string
BeispielTECHNOLOGY
use_case
string
BeispielACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
Beispielstring
description
string
BeispielUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
Beispieltrue
direct_lending
boolean
Beispieltrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
BeispielSample Message
sample_two
string
BeispielAdditional Sample Message
sample_three
string
BeispielAdditional Sample Message
sample_four
string
BeispielAdditional Sample Message
message_flow
string
Beispielstring
help_message
string
Beispielstring
affiliate_marketing
boolean
Beispieltrue
engagement_id
string
BeispielC1DEB879

ID associated with a specific engagement

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

Beispiel Antwort

{
   "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

Pfad Parameter

engagement_id
string
Erforderlich
BeispielC1DEB879

ID associated with a specific engagement

Antworten
Inhalt Typ
application/json

Return a single engagement

identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

vertical
string
BeispielTECHNOLOGY
use_case
string
BeispielACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
Beispielstring
description
string
BeispielUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
Beispieltrue
direct_lending
boolean
Beispieltrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
BeispielSample Message
sample_two
string
BeispielAdditional Sample Message
sample_three
string
BeispielAdditional Sample Message
sample_four
string
BeispielAdditional Sample Message
message_flow
string
Beispielstring
help_message
string
Beispielstring
affiliate_marketing
boolean
Beispieltrue
engagement_id
string
BeispielC1DEB879

ID associated with a specific engagement

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

Beispiel Antwort

{
   "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

Pfad Parameter

engagement_id
string
Erforderlich
BeispielC1DEB879

ID associated with a specific engagement

Anfrage Körper
Inhalt Typ
application/json

identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

vertical
string
BeispielTECHNOLOGY
use_case
string
BeispielACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
Beispielstring
description
string
BeispielUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
Beispieltrue
direct_lending
boolean
Beispieltrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
BeispielSample Message
sample_two
string
BeispielAdditional Sample Message
sample_three
string
BeispielAdditional Sample Message
sample_four
string
BeispielAdditional Sample Message
message_flow
string
Beispielstring
help_message
string
Beispielstring
affiliate_marketing
boolean
Beispieltrue

Beispiel Anfrage

{
   "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
}

Antworten
Inhalt Typ
application/json

Return a single engagement

identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

vertical
string
BeispielTECHNOLOGY
use_case
string
BeispielACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
Beispielstring
description
string
BeispielUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
Beispieltrue
direct_lending
boolean
Beispieltrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
BeispielSample Message
sample_two
string
BeispielAdditional Sample Message
sample_three
string
BeispielAdditional Sample Message
sample_four
string
BeispielAdditional Sample Message
message_flow
string
Beispielstring
help_message
string
Beispielstring
affiliate_marketing
boolean
Beispieltrue
engagement_id
string
BeispielC1DEB879

ID associated with a specific engagement

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

Beispiel Antwort

{
   "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

Pfad Parameter

engagement_id
string
Erforderlich
BeispielC1DEB879

ID associated with a specific engagement

Anfrage Körper
Inhalt Typ
application/json

identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

vertical
string
BeispielTECHNOLOGY
use_case
string
BeispielACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
Beispielstring
description
string
BeispielUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
Beispieltrue
direct_lending
boolean
Beispieltrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
BeispielSample Message
sample_two
string
BeispielAdditional Sample Message
sample_three
string
BeispielAdditional Sample Message
sample_four
string
BeispielAdditional Sample Message
message_flow
string
Beispielstring
help_message
string
Beispielstring
affiliate_marketing
boolean
Beispieltrue

Beispiel Anfrage

{
   "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
}

Antworten
Inhalt Typ
application/json

Return a single engagement

identity_id
string
BeispielBLQKOPK

Identity ID associated with a number

vertical
string
BeispielTECHNOLOGY
use_case
string
BeispielACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
Beispielstring
description
string
BeispielUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
Beispieltrue
direct_lending
boolean
Beispieltrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
BeispielSample Message
sample_two
string
BeispielAdditional Sample Message
sample_three
string
BeispielAdditional Sample Message
sample_four
string
BeispielAdditional Sample Message
message_flow
string
Beispielstring
help_message
string
Beispielstring
affiliate_marketing
boolean
Beispieltrue
engagement_id
string
BeispielC1DEB879

ID associated with a specific engagement

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

Beispiel Antwort

{
   "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

Pfad Parameter

engagement_id
string
Erforderlich
BeispielC1DEB879

ID associated with a specific engagement

Antworten

No content

Numbers

APIs relating to working with Numbers in Engagements

Verfügbare Operationen

Retrieve Numbers associated with an engagement

Get numbers in engagement

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

Pfad Parameter

engagement_id
string
Erforderlich
BeispielC1DEB879

ID associated with a specific engagement

Antworten
Inhalt Typ
application/json

List of numbers that are associated with an engagement

page_size
integer
Beispiel10

Items per page

page
integer
Min1
Beispiel2

Page Offset

total_pages
integer
Min1
Beispiel100

Number of pages in the entire result set

total_items
integer
Beispiel100

Number of items in the entire result set

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

Beispiel Antwort

{
   "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

Pfad Parameter

engagement_id
string
Erforderlich
BeispielC1DEB879

ID associated with a specific engagement

Anfrage Körper
Inhalt Typ
application/json

numbers
array
Erforderlich

Beispiel Anfrage

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

Antworten
Inhalt Typ
application/json

Successful bulk operation

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

Beispiel Antwort

{
   "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

Pfad Parameter

engagement_id
string
Erforderlich
BeispielC1DEB879

ID associated with a specific engagement

Anfrage Körper
Inhalt Typ
application/json

numbers
array
Erforderlich

Beispiel Anfrage

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

Antworten
Inhalt Typ
application/json

Successful bulk operation

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

Beispiel Antwort

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