Table of Contents

maxLevel	3

Introduction

With our API it is possible to create PayLinks, e-Mandates and import records for our scripts. To use the PayLink and e-Mandate service, additional configuration and setup are required. Please contact our customer support if you would like to use additional services.

GraphQL

Our API is written in GraphQL. On How To GraphQL you can read the fundamentals. Creating PayLinks should be as easy as using REST an API. We have added some examples on how to use our API with a GraphQL Client.

To explore our API and its documentation you could use the Altair GraphQL Client. This client has the option to set the required authentication header. Watch this demo video to view how to use the built-in documentation browser.

Image Removed

API endpoint

Code Block
https://reminders.alphacommapi.com/v1

Test endpoint

Contact us for the test endpoint and credentials.

API Keys

You will need an access key to connect to our API. Your keys can be managed through our portal. At the portal go to "Account → API keys". You will need to be a portal manager for your company to access this page.

Key usage

For each request set the "X-AUTH-TOKEN" HTTP header with your key.

Key IP restriction

It is possible to allow keys to only work form certain IP addresses.

Code Block
127.1.1.1 192.1.0.0/32

Code example

We created one request example in PHP to get you started.

APIs

Through our API we provide multiple services. The requirements for fields are defined in the API itself. Use a GraphQL client to view the documentation. In this document we will give you some examples to get started.

All the dates fields in our responses are formatted in RFC 3339, 'Y-m-d\TH:i:sP'.

Import

The import API is an alternative for our batch SFTP (CSV) import. Through this endpoint you are able to import records. The records are batched by day of import and visible in the portal at the import page.

The reminder results are reported at the end of the day in one or multiple result files, grouped by script. For more information see our Annabel Platform Dataformat document.

Required fields

The scripts that are setup in our portal may be setup for voice messages, text messages or emails, that optionally contain a PayLink or e-Mandate. Each script has his own set of required fields.

When a new script is setup we will provide a list of required fields.

Status codes

More information about status codes, these are used at the portal and API.

Batch statuses

Name	Description
empty	No records added to this batch yet.
queued	Records are waiting to be processed.
running	Records are being processed.
done	Records have finished processing.
error	Something went wrong.

Record statuses

Name	Description
notLoaded	Records that could not be read.
loaded	Records that have been read.
rejected	Records that could not be converted into a job.
accepted	Records that could be converted into a job.
enriching	Records that are currently enriching.
created	Records that have created a new job.
updated	Records that have updated an existing job.
dropped	Records that could not be saved to the database.

Input options

Through the 'addRecords' mutation you are able to add records.

Argument

Description

When to use

rows [RowInput!]

An endpoint that has a preset of fields.

This is the preferred way to deliver your records and usable in most cases.
Use this option for small batches or loose records.

file [FileInput!]

Base64 encoded file.

For example: csv, xml, xlsx, xls, ods.

For large batch import, 1000 or more.
Or when your script requires fields that are not available at the RowInput.

If you have questions please contact us.

Examples

When we setup a new script we will inform you about the required fields.

Row Input

This an example for a mail with PayLink record using the RowInput.

Query

Code Block
mutation addRecords ( $file: FileInput, $rows: [RowInput!] ) { import { addRecords(file: $file, rows: $rows) { name action status records { scriptId status messages { context message level } } } } }

Variables

Code Block

{
    "rows": [
      {
        "reference": "f0e7a0c3",
        "script": "1001",
        "personFamilyName": "Alphacomm",
        "toMailAddress": "reminders@alphacomm.nl",
        "invoiceDescription": "Example payment",
        "invoiceDate": "2019-04-04",
        "invoiceDueDate": "2019-07-30",
        "invoiceReference": "40824524",
        "invoiceCurrency": "EUR",
        "invoiceAmount": "56445",
        "invoiceNumber": "249075245",
        "personBirthDay": "2000-01-01"
      }
    ]
}

Response

Code Block
{ "data": { "import": { "addRecords": { "name": "20190403-965", "action": "IMPORT", "status": "done", "records": [ { "scriptId": "1001", "status": "accepted", "messages": [] } ] } } } }

File Input

This is an example with FileInput. Your file should be send as Base64 encoded string. An imported file will always response with a status queued, The slight delay is deliberate, because we need time to process all records. It's possible to send a second request to get the status of the batch.

Query

Code Block
mutation addFile ( $file: FileInput, $rows: [RowInput!] ) { import { addRecords(file: $file, rows: $rows) { name action status } } }

Variables

Code Block
{ "file": { "extension": "csv", "contents": "<<BASE64 ENCODED STRING>>" } }

Response

Code Block
{ "data": { "import": { "addRecords": { "name": "20190404-579", "action": "IMPORT", "status": "queued", "records": [] } } } }

Search batches

This is an example of searching for a batch by name.

Query

Code Block
query ImportSearch( $filters: BatchFiltersInput ) { import { batches( filters: $filters ) { items { name action status } pagination { offset limit total } } } }

Variables

Code Block
{ "filters": { "name": { "equalTo": "Test" } } }

Response

Code Block{ "data": { "import": { "batches": { "items": [ { "name": "Test", "action": "VALIDATE", "status": "empty" } ], "pagination": { "offset": 0, "limit": 20, "total": 1

Table of Contents

maxLevel	4

Introduction

With our API it is possible to create PayLinks, e-Mandates and import records for our scripts. To use the PayLink and e-Mandate service, additional configuration and setup are required. Please contact our customer support if you would like to use additional services.

Please also read our Import and Result Data formats document.

GraphQL

Our API is written in GraphQL. On How To GraphQL you can read the fundamentals. Creating PayLinks should be as easy as using a REST API. We have added some examples of how to use our API with a GraphQL Client.

To explore our API and its documentation you could use the Altair GraphQL Client. This client has the option to set the required authentication header. Watch this demo video to view how to use the built-in documentation browser.

Image Added

Example collection for Altair

To explore our API and view all available fields, import the following collection to the Altair Client and update the header with your API key.

View file

name	alphacomm_collectmaxx_example.agc

API endpoint

Code Block
https://reminders.alphacommapi.com/v1

We use load balancers so a IP change is possible at any time.

Test endpoint

Contact us for the test endpoint and credentials.

API Keys

You will need an access key to connect to our API. Your keys can be managed through our portal. At the portal go to "Account → API keys". You must be a portal manager for your company to access this page.

Key usage

For each request set the "X-AUTH-TOKEN" HTTP header with your key.

Key IP restriction

It is possible to allow keys to only work from certain IP addresses.

Code Block
127.1.1.1 192.1.0.0/32

Code example

We created one request example in PHP to get you started.

APIs

Through our API we provide multiple services. The requirements for fields are defined in the API itself. Use a GraphQL client to view the documentation. In this document, we will give you some examples to get started.

All the dates fields in our responses are formatted in RFC 3339, 'Y-m-d\TH:i:sP'.

Import

The import API is an alternative for our batch SFTP (CSV) import. Through this endpoint, you are able to import records. The records are batched and visible in the portal on the import page.

Note
When sending records to our API, we still starting import the records according to your account’s Import schedule. These import windows are visible at your upload page.

Info
The reminder results are reported at the end of the day in one or multiple result files, grouped by script. For more information see our Import and Result Data formats document.

Required fields

The scripts that are set up in our portal may be set up for voice messages, text messages or emails, that optionally contain a PayLink or e-Mandate. Each script has its own set of required fields.

When a new script is set up we will provide a list of required fields. You can also use our matrix of required fields for medium and services.

Status codes

More information about status codes, which are used at the portal and API.

Batch statuses

Name	Description
empty	No records added to this batch yet.
queued	Records are waiting to be processed.
running	Records are being processed.
done	Records have finished processing.
error	Something went wrong.

Record statuses

Name	Description
notLoaded	Records that could not be read.
loaded	Records that have been read.
rejected	Records that could not be converted into a job.
accepted	Records that could be converted into a job.
enriching	Records that are currently enriching.
created	Records that have created a new job.
updated	Records that have updated an existing job.
dropped	Records that could not be saved to the database.

Input options

Through the 'addRecords' mutation you are able to add records.

Argument

Description

When to use

rows [RowInput!]

An endpoint that has a preset of fields.

This is the preferred way to deliver your records and usable in most cases.
Use this option for small batches or loose records.

file [FileInput!]

Base64 encoded file.

For example: csv, xml, xlsx, xls, ods.

For large batch import, 1000 or more.
Or when your script requires fields that are not available at the RowInput.

If you have questions please contact us.

Examples

When we set up a new script we will inform you about the required fields.

Row Input

This is an example of a mail with PayLink record using the RowInput.

Status
colour Green
title POST
Query body

Code Block

mutation addRecords (
  $file: FileInput,
  $rows: [RowInput!]
) {
  import {
    addRecords(file: $file, rows: $rows) {
      name
      action
      status
      records {
        scriptId
        status
        reference
        messages {
          context
          message
          level
        }
      }
    }
  }
}

PayLink

To use this service we need to configure your iDEAL bank credentials and setup a landing page. Please contact us if you would like to use this service.

Status codes

Name

Description

ready

PayLink is created in our service.

started

Transaction has been started.

partially_paid

A part of the original PayLink amount is paid.

paid

The complete PayLink amount is paid.

cancelled

The last transaction of the PayLink has been cancelled.

failed

The last transaction of the PayLink has failed.

Examples

To make your start easier we have added some examples of common actions.

Keep in mind to use the POST method on all your request.

Create PayLink

Query

When using GraphQL you have the ability to define what fields you get in the response. For this example we only want the id of the created PayLink and the URLs.

Code Blockmutation createPayLink($payLink: PayLinkInput!){ payLink { create (payLink: $payLink) { id

Variables

Code Block
{ "rows": [ { "reference": "f0e7a0c3", "script": "1001", "personFamilyName": "Alphacomm", "toMailAddress": "reminders@alphacomm.nl", shortUrl "toPhoneNumbers" => [ longUrl } "+31612345678", } }

Variables

This is the minimal information we need to create a PayLink.

Code Block

{    "payLink": {     "personName": "Alphacomm",
    "invoiceAmount": "15497",
    "invoiceCurrency": "EUR",
    ],
        "invoiceDescription": "Example payment",
    "invoiceReference": "103482",
           "invoiceDate": "2019-02-12T10:00:00+00:00"
  }
}

Response

Code Block

{04-04",
        "datainvoiceDueDate": {"2019-07-30",
        "payLinkinvoiceReference": {"40824524",
        "createinvoiceCurrency": {"EUR",
        "idinvoiceAmount": "a62c3726-d3b2-4b8c-8e4c-48ee0fd9451c56445",
        "shortUrlinvoiceNumber": "https://ibanaccept.com/u8t1nbw249075245",
        "longUrlpersonBirthDay": "https://alphacomm.ibanaccept.com/pay/a62c3726-d3b2-4b8c-8e4c-48ee0fd9451c2000-01-01"
      }
    }
 ]
}
}

Simple PayLink search

A basic search on all PayLinks.

Query

Code Block

language	php

query { payLink

Response
Status
title 200

We only return the records that were send during the request. This makes it easier to validate if added records are accepted, using the record’s reference.

Code Block
{ "data": { payLinks"import": { items"addRecords": { status"name": "20190403-965", id"action": "IMPORT", } "status": "done", } } }

Variables

No variables needed for this query.

Code Block
{}

Response

Code Block

{   "datarecords": [
{     "payLink": {    {
  "payLinks": {         "itemsreference": [
          {
            "status": "paid""f0e7a0c3",
            "idscriptId": "a6e8b63c-927f-476b-8d47-d323e20e1a4f"
          }1001",
          {             "status": "cancelledaccepted",
            "idmessages": "348bd90d-da76-4211-93c3-601cbb15f33a"[]
          },
        ]
 {     }
    }
  "status": "ready",
            "id": "389f0187-6b5d-4896-8d78-e56a6bb1a156"
          }
        ]
      }
    }
  }
}

Find single PayLink

An example of how to get the status of a single PayLink.

Query

Code Block

language	php

query PayLinks(
  $filters: PayLinkFiltersInput
) {
  payLink {
    payLinks (
      filters: $filters
    ) {
        items}
}

File Input

This is an example with FileInput. Your file should be sent as a Base64 encoded string. An imported file will always respond with a status queued. The slight delay is deliberate because we need time to process all records. It is possible to send a second request to get the status of the batch.

Status
colour Green
title POST
Query body

Code Block
mutation addFile ( $file: FileInput, $rows: [RowInput!] ) { import { addRecords(file: $file, rows: $rows) { name action status } } }

Variables

Code Block
{ "file": { "extension": "csv", "contents": "<<BASE64 ENCODED STRING>>" } }

Response
Status
title 200

When a file is imported we will always respond with a status queued. Bacause we need some time to process the file.

Code Block
{ "data": { "import": { "addRecords": { id "name": "20190404-579", personName "action": "IMPORT", personGender "status": "queued", status "records": [] amountPaid } } } createdOn}

Search batches

This is an example of searching for a batch by name.

Status
colour Green
title POST
Query body

Code Block
query ImportSearch( $filters: BatchFiltersInput ) { import { updatedOn batches( } filters: $filters } ) { } }

Variables

Code Block
{ "filters":items { "id": { name "equalTo": "5be41c4f-9fe6-403d-980b-5edc0139ee70" action } } }

Response

Code Block
{ "data":status { "payLink": {} "payLinks":pagination { "items":offset [ limit { total "id": "5be41c4f-9fe6-403d-980b-5edc0139ee70",} } } }

Variables

Code Block
{ "personNamefilters": "Demo",{ "name": { "personGenderequalTo": "UTest", } } }

Response
Status
title 200

Code Block

{
  "statusdata": "paid",{
    "import": {
      "amountPaidbatches": {
        "items": [
          {
            "name": 0"Test",
            "createdOnaction": "2019-02-05T09:57:14+00:00VALIDATE",
            "updatedOnstatus": "2019-02-05T09:57:14+00:00empty"
          }
        ],
        "pagination": {
     }     }
"offset": 0,
 } }

Advanced PayLink search

An example of how to find all PayLinks with the status paid created on 08-02-2019.

You have the option to set filters, order, offset and limit. All the options are defined in the API docs.

Query

Code Block

language	php

query PayLinks(   $filters: PayLinkFiltersInput   $order"limit": PayLinkOrderInput20,
  $offset: Int   $limit: Int ) {
  payLink {
    payLinks (
      filters: $filters "total": 1
      order: $order }
     offset: $offset}
    }
 limit: $limit
    ) {
        items {
          id
          personName
          personGender
 }
}

PayLink

To use this service we need to configure your iDEAL bank credentials and set up a landing page. Please contact us if you would like to use this service.

Status codes

Name	Description
ready	PayLink is created in our service.
started	Transaction has been started.
partially_paid	A part of the original PayLink amount is paid.
paid	The complete PayLink amount is paid.
cancelled	The last transaction of the PayLink has been cancelled.
failed	The last transaction of the PayLink has failed.

Examples

To make your start easier we have added some examples of common actions.

Keep in mind to use the POST method on all your request.

Create PayLink

When using GraphQL you have the ability to define what fields you get in the response. For this example, we only want the id of the created PayLink and the URLs.

Status
colour Green
title POST
Query body

Code Block
mutation createPayLink($payLink: PayLinkInput!){ payLink { create (payLink: $payLink) { attributes status { id value } id shortUrl longUrl } } }

Variables

This is the minimal information we need to create a PayLink.

Us the field visibleUntil to set the date when payment should not be possible anymore.

By default, the PayLink expires 90 days after the date of creation.

Code Block
{ "payLink": { "attributes": [ {"id": amountPaid createdOn updatedOn } pagination { offset limit total } } } }

Variables

Code Block

{
  "filters": {
    "status": {
      "equalTo": "paid"
    },
    "createdOn": {
      "greaterThan": "2019-02-08T00:00:00+00:00",
      "lesserThan": "2019-02-09T00:00:00+00:00"
    }
  },
  "order": {
    "createdOn": "DESCENDING"
  },
  "offset": 0,
  "limit": 20
}

Response

Code Block

{
  "data": {
    "payLink": {
      "payLinks": {
        "items": [
          {
            "id": "5be41c4f-9fe6-403d-980b-5edc0139ee70",
            "personName": "Demo",
            "personGender": "U",
   "source", "value": "whatsapp"}
    ],
    "personName": "Alphacomm",
    "invoiceAmount": "15497",
    "invoiceCurrency": "EUR",
    "invoiceDescription": "Example",
    "invoiceReference": "103482",
    "invoiceDate": "2019-02-12T10:00:00+00:00"
  }
}

Response
Status
title 200

Code Block

{
  "data": {
    "payLink": {
      "create": {
        "attributes": [
          {
            "id": "customer_source",
            "value": "whatsapp"
          },
          {
            "id": "origin",
            "value": "api"
          }
        ],
        "id": "a62c3726-d3b2-4b8c-8e4c-48ee0fd9451c",
        "shortUrl": "https://ibanaccept.com/u8t1nbw",
        "longUrl": "https://alphacomm.ibanaccept.com/pay/a62c3726-d3b2-4b8c-8e4c-48ee0fd9451c"
      }
    }
  }
}

Simple PayLink search

A basic search on all PayLinks.

Status
colour Green
title POST
Query body

Code Block

language	php

query {
  payLink {
    payLinks {
      items {
        status
        id
      }
      pagination {
        offset
        limit
        total
      }
    }
  }
}

Variables

No variables are needed for this query.

Code Block
{}

Response
Status
title 200

Code Block

{
  "data": {
    "payLink": {
      "payLinks": {
        "items": [
          {
            "status": "paid",
            "id": "a6e8b63c-927f-476b-8d47-d323e20e1a4f"
          },
          {
            "status": "cancelled",
            "id": "348bd90d-da76-4211-93c3-601cbb15f33a"
          },
          {
            "status": "ready",
            "id": "389f0187-6b5d-4896-8d78-e56a6bb1a156"
          }
        ],
        "pagination": {
          "offset": 0,
          "limit": 20,
          "total": 3
        }
      }
    }
  }
}

Find Single PayLink

An example of how to get the status of a single PayLink.

Status
colour Green
title POST
Query body

Code Block

language	php

query PayLinks(
  $filters: PayLinkFiltersInput
) {
  payLink {
    payLinks (
      filters: $filters
    ) {
        items {
          id
          personName
          personGender
          status
          amountPaid
          createdOn
          updatedOn
        }
      }
    }
}

Variables

Code Block
{ "filters": { "id": { "equalTo": "5be41c4f-9fe6-403d-980b-5edc0139ee70" } } }

Response
Status
title 200

Code Block

{
  "data": {
    "payLink": {
      "payLinks": {
        "items": [
          {
            "id": "5be41c4f-9fe6-403d-980b-5edc0139ee70",
            "personName": "Demo",
            "personGender": "U",
            "status": "paid",
            "amountPaid": 0,
            "createdOn": "2019-02-05T09:57:14+00:00",
            "updatedOn": "2019-02-05T09:57:14+00:00"
          }
        ]
      }
    }
  }
}

Search PayLink with record identifer

PayLinks can not only be created through our API but also though the import to our scripts. In this last case the PayLink is delivered by us via email or SMS.

During a record import you are required to define the ‘idenfification_identifier' or also called 'reference’. In case you want to know what the current status of the PayLink is your are able to search our PayLink service with this reference.

Status
colour Green
title POST
Query body

Code Block

language	php

query PublicApiPayLinks(
  $filters: PayLinkFiltersInput
  $order: PayLinkOrderInput
  $offset: Int
  $limit: Int
) {
  payLink {
    payLinks (
      filters: $filters
      order: $order
      offset: $offset
      limit: $limit
    ) {
        items {
          attributes {
            id
            value
          }
          id
          personName
          personGender
          status
        }
      }
    }
}

Variables

Code Block
{ "filters": { "attributes": [ { "id": "reference", "equalTo": "20220216-6" } ] } }

Response
Status
title 200

Code Block

{
  "data": {
    "payLink": {
      "payLinks": {
        "items": [
          {
            "attributes": [
              {
                "id": "origin",
                "value": "sms"
              },
              {
                "id": "script",
                "value": "1003"
              },
              {
                "id": "reference",
                "value": "20220216-6"
              }
            ],
            "id": "42c949b9-5945-4273-912d-00f5563df1fd",
            "personName": "Alphacomm",
            "personGender": "M",
            "status": "ready"
          }
        ]
      }
    }
  }
}

Advanced PayLink search

An example of how to find all PayLinks with the status paid created on 08-02-2019.

You have the option to set filters, order, offset and limit. All the options are defined in the API docs.

Status
colour Green
title POST
Query body

Code Block

language	php

query PayLinks(
  $filters: PayLinkFiltersInput
  $order: PayLinkOrderInput
  $offset: Int
  $limit: Int
) {
  payLink {
    payLinks (
      filters: $filters
      order: $order
      offset: $offset
      limit: $limit
    ) {
        items {
          id
          personName
          personGender
          status
          amountPaid
          createdOn
          updatedOn
        }
        pagination {
          offset
          limit
          total
        }
      }
    }
}

Variables

Code Block

{
  "filters": {
    "status": {
      "equalTo": "paid"
    },
    "createdOn": {
      "greaterThan": "2019-02-08T00:00:00+00:00",
      "lesserThan": "2019-02-09T00:00:00+00:00"
    }
  },
  "order": {
    "createdOn": "DESCENDING"
  },
  "offset": 0,
  "limit": 20
}

Response
Status
title 200

Code Block

{
  "data": {
    "payLink": {
      "payLinks": {
        "items": [
          {
            "id": "5be41c4f-9fe6-403d-980b-5edc0139ee70",
            "personName": "Demo",
            "personGender": "U",
            "status": "paid",
            "amountPaid": 0,
            "createdOn": "2019-02-05T09:57:14+00:00",
            "updatedOn": "2019-02-05T09:57:14+00:00"
          },
          {
            "id": "96f3cf79-98ab-43d1-80ca-fa5c9fccab23",
            "personName": "Test Person",
            "personGender": "U",
            "status": "paid",
            "amountPaid": 0,
            "createdOn": "2019-02-01T14:49:35+00:00",
            "updatedOn": "2019-02-01T14:49:36+00:00"
          }
        ],
        "pagination": {
          "offset": 0,
          "limit": 0,
          "total": 2
        }
      }
    }
  }
}

E-Mandate

To use this service we need to configure your e-Mandate bank credentials and setup a landing page. Please contact us if you would like to use this service.

Status codes

Name	Description
new	Mandate is created on our service.
pending	Waiting for second authorization.
success	Mandate is given.

Examples

To make your start easier we have added some examples of common actions.

Keep in mind to use the POST method on all your request.

Create Mandate

When using GraphQL you have the ability to define what fields you get in the response. For this example, we only want the id, reference, URLs and type.

Status
colour Green
title POST
Query body

Code Block
mutation createMandate($mandate: MandateInput!){ mandate { create (mandate: $mandate) { id reference shortUrl longUrl type } } }

Variables

Example values.

Code Block
{ "mandate": { "personName": "Alphacomm", "reference": "AC-HUUR" "type": "RCUR", "reason": "huur", "debtorReference": "20190301" } }

Response
Status
title 200

Code Block

{
  "data": {
    "mandate": {
      "create": {
        "id": "4442ddf6-7371-4e6a-8939-087f8fd3b17c",
        "reference": "AC-HUUR",
        "shortUrl": "https://betaalmachtiging.nl/akps797",
        "longUrl": "https://alphacomm.betaalmachtiging.nl/pay/94e592f0-9f21-4404-bdfe-a6e51c6bf547",
        "type": "RCUR"
      }
    }
  }
}

Simple Mandate search

A basic search query for all Mandates.

Status
colour Green
title POST
Query body

Code Block

language	php

query {
  mandate {
    mandates {
      items {
        status
        id
      }
    }
  }
}

Variables

No variables are needed for this query.

Code Block
{}

Response
Status
title 200

Code Block

{
  "data": {
    "mandate": {
      "mandates": {
        "items": [
          {
            "status": "new",
            "id": "a6e8b63c-927f-476b-8d47-d323e20e1a4f"
          },
          {
            "status": "pending",
            "id": "348bd90d-da76-4211-93c3-601cbb15f33a"
          },
          {
            "status": "success",
            "id": "389f0187-6b5d-4896-8d78-e56a6bb1a156"
          }
        ]
      }
    }
  }
}

Find Single Mandate

An example of how to get the status of a single Mandate.

Status
colour Green
title POST
Query body

Code Block

language	php

query Mandates(
  $filters: MandateFiltersInput
) {
  mandate {
    mandates (
      filters: $filters
    ) {
        items {
          id
          personName
          status
          createdOn
          updatedOn
        }
      }
    }
}

Variables

Code Block
{ "filters": { "id": { "equalTo": "5be41c4f-9fe6-403d-980b-5edc0139ee70" } } }

Response
Status
title 200

Code Block

{
  "data": {
    "mandate": {
      "mandates": {
        "items": [
          {
            "id": "5be41c4f-9fe6-403d-980b-5edc0139ee70",
            "personName": "Demo",
            "status": "success",
            "createdOn": "2019-02-05T09:57:14+00:00",
            "updatedOn": "2019-02-05T09:57:14+00:00"
          }
        ]
      }
    }
  }
}

Advanced Mandate search

An example of how to find all e-Mandates with the status success, created on 08-02-2019.

You have the option to set filters, order, offset and limit. All the options are defined in the API docs.

Status
colour Green
title POST
Query body

Code Block

language	php

query Mandates(
  $filters: MandateFiltersInput
  $order: MandateOrderInput
  $offset: Int
  $limit: Int
) {
  mandate {
    mandates (
      filters: $filters
      order: $order
      offset: $offset
      limit: $limit
    ) {
        items {
          id
          personName
          status
          createdOn
          updatedOn
        }
        pagination {
          offset
          limit
          total
        }
      }
    }
}

Variables

Code Block

{
  "filters": {
    "status": {
      "equalTo": "success"
    },
    "createdOn": {
      "greaterThan": "2019-02-08T00:00:00+00:00",
      "lesserThan": "2019-02-09T00:00:00+00:00"
    }
  },
  "order": {
    "createdOn": "DESCENDING"
  },
  "offset": 0,
  "limit": 20
}

Response
Status
title 200

Code Block

{
  "data": {
    "mandate": {
      "mandates": {
        "items": [
          {
            "id": "5be41c4f-9fe6-403d-980b-5edc0139ee70",
            "personName": "Demo",
            "status": "success",
            "createdOn": "2019-02-05T09:57:14+00:00",
            "updatedOn": "2019-02-05T09:57:14+00:00"
          },
          {
            "id": "96f3cf79-98ab-43d1-80ca-fa5c9fccab23",
            "personName": "Test Person",
            "status": "success",
            "createdOn": "2019-02-01T14:49:35+00:00",
            "updatedOn": "2019-02-01T14:49:36+00:00"
          }
        ],
        "pagination": {
          "offset": 0,
          "limit": 0,
          "total": 2
        }
      }
    }
  }
}

Voice

To use this service we need to configure a voice script. Please contact us if you would like to use this service.

Examples

To make your start easier we have added some examples of common actions.

Stop Calling

Use this action to remove any leftover scheduled voice calls, related to the specified scriptId and reference.

Status
colour Green
title POST
Query body

Code Block
mutation stopCalling( $scriptId: Int! $reference: String! ){ voice { stopCalling ( scriptId: $scriptId reference: $reference ) } }

Variables

Code Block
{ "scriptId": 18301, "reference": "your_identifier" }

Response
Status
title 200

Code Block
{ "data": { "voice": { "stopCalling": "done" } } }

Webhook events

Note
We are working on adding more events and improving the information in the payload. So the content of the data might change.

Voice

Call completed

Field

Format

datetime
string

When the event occurred

RFC3339
2023-10-12T07:20:50.52Z

id
string

Identifying the call.

UUID

d670a4af-8562-4d5f-ae30-5cc36acf82ee

serviceId
string

Identifier of the Call Request.

UUID

a2654d8a-3f8d-402e-a03b-980953802a09

serviceId
string

voice

reference
string

Identifier used during import, also know as identification_identifier

event
string

Code Block
VoiceCallCompleted

data
array

See Data table below.

Data

direction
string

Call direction

ENUM DIRECTION

Code Block
outbound inbound

status
string

The call status

ENUM STATUS

Code Block
ringing active finished no answer busy rejected invalid number failed

localNumber
string

E164

remoteNumber
string

E164

events
array

Array of events during the call,
contains the following fields

Code Block

language	json

nodeId: string, node identifier
nodeType: string, ENUM NODETYPE
order: int, event order
type: string, ENUM EVENTTYPE
data: array, data that is specific to the node type and event type
time: string, RFC3339

Empty when call is not answered.

Code Block

NODETYPE:
  AddResult
  CheckCallAttempt
  CheckCounter
  CheckGenderBirthday
  CheckVariable
  DTMF
  DTMFString
  Forward
  Hangup
  IsCallOutbound
  IsRemoteMobile
  IsRemoteVoiceMail
  IsTimeInInterval
  Sound
  WaitForSilence

EVENTTYPE:
  NodeStart
  NodeUpdate
  NodeResult

answeredOn
string

not set if the call has not been answered.

RFC3339
2019-10-12T07:20:50.52Z

Example

Expand

title	Call completed, answered

Code Block

{
  "datetime": "2022-09-08T14:22:52+00:00",
  "id": "f3e445ce-75ee-4c94-9d6d-370949664fd7",
  "serviceId": "f3e445ce-75ee-4c94-9d6d-370949664fd7",
  "service": "voice",
  "reference": "20231208-1547471",
  "event": "VoiceCallCompleted",
  "data": {
    "direction": "outbound",
    "status": "finished",
    "localNumber": "3225882397",
    "remoteNumber": "316123456789",
    "answeredOn": "2022-09-08T14:23:10+00:00",
    "events": [
      {
        "nodeId": "vm_beep",
        "

status

nodeType": "

paid

Sound",

amountPaid

order":

0

1,

createdOn

type": "

2019-02-05T09:57:14+00:00

NodeStart",
        "data": [],
        "

updatedOn

time": "

2019

2022-

02

09-

05T09

08T14:

57

23:

14

13+00:00"

},

id

nodeId": "

96f3cf79-98ab-43d1-80ca-fa5c9fccab23

vm_beep",

personName

nodeType": "

Test Person

Sound",

personGender

order":

"U"

2,

status

type": "

paid

NodeResult",

amountPaid

data":

0,

[],
        "

createdOn

time": "

2019

2022-

02

09-

01T14

08T14:

49

23:

35

16+00:00"

,


      },
      {

"updatedOn":

"2019-02-01T14:49:36+00:00"

      "nodeId": "vm_wait_for_silence",

}

]

"nodeType": "WaitForSilence",
        "

pagination

order":

{

3,

offset

type":

0

"NodeStart",

limit

data":

0

[],

total

time":

2

"2022-09-08T14:23:17+00:00"
      },

}

} }

E-Mandate

To use this service we need to configure your e-Mandate bank credentials and setup a landing page. Please contact us if you would like to use this service.

Status codes

Name

Description

new

Mandate is created on our service.

pending

Waiting for second authorization.

success

Mandate is given.

Examples

To make your start easier we have added some examples of common actions.

Keep in mind to use the POST method on all your request.

Create Mandate

Query

When using GraphQL you have the ability to define what fields you get in the response. For this example we only want the id, reference, the URLs and type.

Code Block

mutation createMandate($mandate: MandateInput!){ mandate { create (mandate: $mandate) {

 "nodeId": "vm_wait_for_silence",
        "nodeType": "WaitForSilence",
        "order": 4,
        "type": "NodeResult",
        "data": [],
        "time": "2022-09-08T14:23:18+00:00"
      },
      {
        "nodeId": "name",

id

"nodeType": "Sound",

reference

   "order": 5,

shortUrl

longUrl

"type": "NodeStart",

type

  "data": [],

}

Variables

Example values.

Code Block

{

mandate": {

time": "2022-09-08T14:23:18+00:00"

"personName": "Alphacomm"

},

"reference":

"AC-HUUR"

"type":

"RCUR",

reason

nodeId": "

huur

name",

debtorReference

nodeType": "

20190301

Sound",

}

Response

Code Block

{

data

order": 6,

{

mandate

type": "NodeResult",

{

create

data":

{

[],
        "

id

time": "

4442ddf6

2022-

7371-4e6a-8939-087f8fd3b17c",

09-08T14:23:20+00:00"
      },

"reference": "AC-HUUR",

 {
        "

shortUrl

nodeId": "

https://betaalmachtiging.nl/akps797

invoice_reference",
        "

longUrl

nodeType": "

https://alphacomm.betaalmachtiging.nl/pay/94e592f0-9f21-4404-bdfe-a6e51c6bf547

Sound",
        "

type

order":

"RCUR"

7,

}

} } }

Simple e-Mandate search

A basic search on all e-Mandates.

Query

Code Block

language	php

query { mandate {

"type": "NodeStart",
        "data": [],

mandates

{

 "time": "2022-09-08T14:23:20+00:00"

items

{

 },
      {

status

id

"nodeId": "invoice_reference",

}

  "nodeType": "Sound",

}

Variables

No variables needed for this query.

Code Block
{}

Response

Code Block

{

data

order": 8,

{

mandate

type":

{

"NodeResult",
        "

mandates

data":

{

[],
        "

items

time":

[

"2022-09-08T14:23:22+00:00"
      },

{

{
        "

status

nodeId": "

new

vmresult",

id

nodeType": "

a6e8b63c-927f-476b-8d47-d323e20e1a4f"

IsRemoteVoiceMail",

}

"order": 9,

{

"type": "NodeStart",

status

data":

"pending",

[],
        "

id

time": "

348bd90d

2022-

da76-4211-93c3-601cbb15f33a"

09-08T14:23:22+00:00"
      },
      {

},

     "nodeId": "vmresult",

{

   "nodeType": "IsRemoteVoiceMail",
        "

status

order":

"success"

10,

id

type": "

389f0187-6b5d-4896-8d78-e56a6bb1a156"

NodeResult",
        "data": {

}

]

 "detected": "HUMAN",

}

} } }

Find single Mandate

An example of how to get a status of a single Mandate.

Query

Code Block

language	php

query Mandates( $filters: MandateFiltersInput ) { mandate { mandates (

 "outcome": "no"
        },

filters: $filters

"time": "2022-09-08T14:23:22+00:00"

)

{

},
      {

items

{

      "nodeId": "text2",

id

     "nodeType": "Sound",

personName

    "order": 11,

status

   "type": "NodeStart",

createdOn

  "data": [],

updatedOn

 "time": "2022-09-08T14:23:22+00:00"
      },

}

Variables

Code Block

{

filters

nodeId":

{ "id": {

"text2",
        "

equalTo

nodeType": "

5be41c4f-9fe6-403d-980b-5edc0139ee70" } } }

Response

Code Block

{

Sound",
        "

data

order": 12,

{

mandate

type":

{

"NodeResult",
        "

mandates

data":

{

[],
        "

items

time":

[

"2022-09-08T14:23:25+00:00"
      },

{

{
        "

id

nodeId": "

5be41c4f-9fe6-403d-980b-5edc0139ee70

success",

personName

nodeType": "

Demo

AddResult",
        "order": 13,
        "

status

type": "

success

NodeStart",
        "data": [],
        "

createdOn

time": "

2019

2022-

02

09-

05T09

08T14:

57

23:

14

25+

00:00",

updatedOn

nodeId": "

2019-02-05T09:57:14+00:00"

success",
        "nodeType": "AddResult",

}

]

"order": 14,

}

  "type": "NodeResult",

}

Advanced Mandate search

An example on how to find all e-Mandates with the status success, created on 08-02-2019.

You have the option to set filters, order, offset and limit. All the options are defined in the API docs.

Query

Code Block

language	php

query

Mandates(

$filters

"data":

MandateFiltersInput

$order:

MandateOrderInput

$offset:

Int

$limit

"result":

Int

"success-ok"

)

{

mandate

{

},

mandates

(

filters: $filters

"time": "2022-09-08T14:23:25+00:00"
      },

order:

$order

offset:

$offset

limit: $limit

"nodeId": "text3",

)

{

  "nodeType": "DTMF",

items

{

  "order": 15,

id

 "type": "NodeStart",

personName

"data": [],

status

"time": "2022-09-08T14:23:25+00:00"
      },

createdOn

updatedOn

 "nodeId": "text3",

}

  "nodeType": "DTMF",

pagination

{

  "order": 16,

offset

 "type": "NodeResult",

limit

"data": {

total

 "input": [

}

"3"

}

Variables

Code Block

{

"filters": {

],

"status":

{

equalTo

outcome": "

success" }, "createdOn": {

tone:3"

"greaterThan": "2019-02-08T00:00:00+00:00",

 },
        "

lesserThan

time": "

2019

2022-

02

09-

09T00

08T14:

00

23:

00

31+00:00"

}

},

"order":

{

"createdOn":

"DESCENDING"

},

offset

nodeId":

0

"pre_send_sms",

"limit":

20

}

Response

Code Block

{

data

nodeType":

{ "mandate": {

"Sound",
        "

mandates

order":

{

17,
        "

items

type":

[

"NodeStart",

{

"data": [],
        "

id

time": "

5be41c4f

2022-

9fe6-403d-980b-5edc0139ee70",

09-08T14:23:32+00:00"

},

"personName":

"Demo",

    {
        "

status

nodeId": "

success

remote_hangup",

createdOn

nodeType": "

2019-02-05T09:57:14+00:00

RemoteHangup",

updatedOn

order":

"2019-02-05T09:57:14+00:00"

18,

}

"type": "RemoteHangup",

{

"data": [],

id

time": "

96f3cf79

2022-

98ab-43d1-80ca-fa5c9fccab23",

09-08T14:23:33+00:00"

"personName": "Test Person",

}
    ]
  }

"status

PayLink

Event

Field

Format

datetime
string

When the event occurred

RFC3339
2023-10-12T07:20:50.52Z

id
string

Identifying the event uniquely

UUID

d670a4af-8562-4d5f-ae30-5cc36acf82ee

serviceId
string

Identifier of the PayLink

UUID

a2654d8a-3f8d-402e-a03b-980953802a09

serviceId
string

paylink

reference
string

Identifier used during import, also know as identification_identifier

Empty when created through our API.

event
string

Code Block
PayLinkVisited PayLinkPaid

data
array

Code Block
{ "payment-method": "

success

ideal",
"transaction-amount": 1344 # Amount in cents
}

Example Paid

Code Block

{
     "createdOndatetime": "20192022-0211-01T1411T11:49:35+00:0011:11.11Z",
  "id": "f3e445ce-75ee-4c94-9d6d-370949664fd7",
     "reference": "",
  "updatedOnserviceId": "2019-02-01T14:49:36+00:00"adbc180b-a494-477f-958d-9f0b050a09c3",
          }
        ]"service": "paylink",
     "event": "PayLinkPaid",
  "paginationdata": {

         "offset"payment-method": 0"ideal",
    "transaction-amount": 114
  }
 "limit": 0,
          "total": 2
        }
      }
    }
  }
}

Voice

To use this service we need to configure a voice script. Please contact us if you would like to use this service.

Examples

To make your start easier we have added some examples of common actions.

Keep in mind to use the POST method on all your request.

Stop calling

Use this action to remove any leftover scheduled voice calls, related to the specified scriptId and reference.

Query

Code Block
mutation stopCalling( $scriptId: Int! $reference: String! ){ voice { stopCalling ( scriptId: $scriptId reference: $reference ) } }

Variables

Code Block
{ "scriptId": 18301, "reference": "your_identifier" }

Response

Code Block
{ "data": { "voice": { "stopCalling": "done" } } }

Webhook

The voice service supports the use of webHooks, the body looks as follows:

Code Block

language	json

FORMAT
id: UUID, identifying the call uniquely
attributes: associative array
direction: string, ENUM DIRECTION
status: string, ENUM STATUS
localNumber: string, E164
remoteNumber: string, E164
events: list of associative arrays with the following format
  nodeId: string, node identifier
  nodeType: string, ENUM NODETYPE
  order: int, event order
  type: string, ENUM EVENTTYPE
  data: array, data that is specific to the node type and event type
  time: string, RFC3339
createdOn: string, RFC3339
updatedOn: string, RFC3339
answeredOn: string, RFC3339, not set if the call has not been answered

ENUMS
direction:
  outbound
  inbound

status:
  ringing
  active
  finished
  no answer
  busy
  rejected
  invalid number
  failed

nodetype:
  AddResult
  CheckCallAttempt
  CheckCounter
  CheckGenderBirthday
  CheckVariable
  DTMF
  DTMFString
  Forward
  Hangup
  IsCallOutbound
  IsRemoteMobile
  IsRemoteVoiceMail
  IsTimeInInterval
  Sound
  WaitForSilence

eventtype:
  NodeStart
  NodeUpdate
  NodeResult

Code Block

language	json

{
	"id": "e7813601-21ae-465c-bd97-96367bebd0ca",
	"attributes": {
		"origin": "annabel",
		"customer": "6500",
		"script": "6512",
		"job": "eb44f88bd968749a620765a382ef3c75c20a657c37499392d59958c5dd944652-06512"
	},
	"direction": "outbound",
	"status": "finished",
	"localNumber": "31513703800",
	"remoteNumber": "31640754459",
	"host": "8ed68ab81de6",
	"events": [}

Voice webhook V1

Call completed Legacy format

The voice service supports the use of webhook messages. When a voice call has been completed the result will be reported to your webhook URL. We can authenticate to your webhook with basic access authentication.

Contact us to configure your webhook URL.

Format

The webhook request is a standard HTTP POST request with a JSON body, which is formatted as follows.

Field

Format

id
string

UUID, identifying the call uniquely

attributes
array

Contains the 'reference' used at import (identification_identifier).

direction
string

Call direction

ENUM DIRECTION

Code Block
outbound inbound

status
string

The call status

ENUM STATUS

Code Block
ringing active finished no answer busy rejected invalid number failed

localNumber
string

E164

remoteNumber
string

E164

events
array

Array of events during the call,
contains the following fields

Code Block

language	json

nodeId: string, node identifier
nodeType: string, ENUM NODETYPE
order: int, event order
type: string, ENUM EVENTTYPE
data: array, data that is specific to the node type and event type
time: string, RFC3339

Empty when call is not answered.

Code Block

NODETYPE:
  AddResult
  CheckCallAttempt
  CheckCounter
  CheckGenderBirthday
  CheckVariable
  DTMF
  DTMFString
  Forward
  Hangup
  IsCallOutbound
  IsRemoteMobile
  IsRemoteVoiceMail
  IsTimeInInterval
  Sound
  WaitForSilence

EVENTTYPE:
  NodeStart
  NodeUpdate
  NodeResult

createdOn
string

RFC3339
2019-10-12T07:20:50.52Z

updatedOn
string

RFC3339
2019-10-12T07:20:50.52Z

answeredOn
string

not set if the call has not been answered.

RFC3339
2019-10-12T07:20:50.52Z

How to determine a call has reached the success point

To determine a call was successful a defined point in the voice message should be reached.

This is always an AddResult type node with a data result value success-ok

Code Block
... "events": [ { "nodeId": "success", "nodeType": "AddResult", "order": 16, "type": "NodeResult", "data": { "result": "success-ok" }, "time": "2020-05-06T08:43:11+00:00" } ] ...

Info
Use the NodeResult type with the data['result'] value when evaluating the events. The NodeId’s are more likely to change when altering voice script flows.

Example message for an outbound call

Expand

Code Block

language	json

{
	"id": "e7813601-21ae-465c-bd97-96367bebd0ca",
	"attributes": {
		"origin": "annabel",
		"customer": "6500",
		"script": "6512",
		"job": "eb44f88bd968749a620765a382ef3c75c20a657c37499392d59958c5dd944652-06512",
		"reference": "API reference / identification_identifier"
	},
	"direction": "outbound",
	"status": "finished",
	"localNumber": "31513703800",
	"remoteNumber": "31640754459",
	"events": [{
		"nodeId": "vm_beep",
		"nodeType": "Sound",
		"order": 1,
		"type": "NodeStart",
		"data": [],
		"time": "2020-05-06T08:42:55+00:00"
	}, {
		"nodeId": "vm_beep",
		"nodeType": "Sound",
		"order": 2,
		"type": "NodeResult",
		"data": [],
		"time": "2020-05-06T08:42:59+00:00"
	}, {
		"nodeId": "vm_wait_for_silence",
		"nodeType": "WaitForSilence",
		"order": 3,
		"type": "NodeStart",
		"data": [],
		"time": "2020-05-06T08:42:59+00:00"
	}, {
		"nodeId": "vm_is_

beep

vm",
		"nodeType": "

Sound

IsRemoteVoiceMail",
		"order":

1

5,
		"type": "NodeStart",
		"data": [],
		"time": "2020-05-06T08:

42

43:

55

00+00:00"
	}, {
		"nodeId": "

vm_beep

text10",
		"nodeType": "Sound",
		"order":

2

7,
		"type": "

NodeResult

NodeStart",
		"data": [],
		"time": "2020-05-06T08:

42

43:

59

00+00:00"
	}, {
		"nodeId": "

vm_wait_for_silence

text10",
		"nodeType": "

WaitForSilence

Sound",
		"order":

3

8,
		"type": "

NodeStart

NodeResult",
		"data": [],
		"time": "2020-05-06T08:

42

43:

59

05+00:00"
	}, {
		"nodeId": "

vm_is_vm

filter",
		"nodeType": "

IsRemoteVoiceMail

CheckGenderBirthday",
		"order":

5

9,
		"type": "NodeStart",
		"data": [],
		"time": "2020-05-06T08:43:

00

05+00:00"
	}, {
		"nodeId": "

text10

filter",
		"nodeType": "

Sound

CheckGenderBirthday",
		"order":

7

10,
		"type": "

NodeStart

NodeResult",
		"data": {
			"gender": "M",
			"age": 2020,
			"outcome":

[]

"man"
		},
		"time": "2020-05-06T08:43:

00

05+00:00"
	}, {
		"nodeId": "

text10

text11m",
		"nodeType": "Sound",
		"order":

8

11,
		"type": "

NodeResult

NodeStart",
		"data": [],
		"time": "2020-05-06T08:43:05+00:00"
	}, {
		"nodeId": "

filter

text11m",
		"nodeType": "

CheckGenderBirthday

Sound",
		"order":

9

12,
		"type": "

NodeStart

NodeResult",
		"data": [],
		"time": "2020-05-06T08:43:

05

08+00:00"
	}, {
		"nodeId": "

filter

name",
		"nodeType": "

CheckGenderBirthday

Sound",
		"order":

10

13,
		"type": "

NodeResult

NodeStart",
		"data":

{ "gender": "M", "age": 2020

[],

outcome": "man" }, "

time": "2020-05-06T08:43:

05

09+00:00"
	}, {
		"nodeId": "

text11m

name",
		"nodeType": "Sound",
		"order":

11

14,
		"type": "

NodeStart

NodeResult",
		"data": [],
		"time": "2020-05-06T08:43:

05

10+00:00"
	}, {
		"nodeId": "

text11m

success",
		"nodeType": "

Sound

AddResult",
		"order":

12

15,
		"type": "

NodeResult

NodeStart",
		"data": [],
		"time": "2020-05-06T08:43:

08

11+00:00"
	}, {
		"nodeId": "

name

success",
		"nodeType": "

Sound

AddResult",
		"order":

13

16,
		"type": "

NodeStart

NodeResult",
		"data": {
			"result":

[]

 "success-ok"
		},
		"time": "2020-05-06T08:43:

09

11+00:00"
	}, {
		"nodeId": "

name

collect_id",
		"nodeType": "Sound",
		"order":

14

17,
		"type": "

NodeResult

NodeStart",
		"data": [],
		"time": "2020-05-06T08:43:

10

11+00:00"
	}, {
		"nodeId": "

success

collect_id",
		"nodeType": "

AddResult

Sound",
		"order":

15

18,
		"type": "

NodeStart

NodeResult",
		"data": [],
		"time": "2020-05-06T08:43:

11

16+00:00"
	}, {
		"nodeId": "

success

text22",
		"nodeType": "

AddResult

Sound",
		"order":

16

19,
		"type": "

NodeResult

NodeStart",
		"data":

{ "result": "success-ok" }

[],
		"time": "2020-05-06T08:43:

11

17+00:00"
	}, {
		"nodeId": "

collect_id

text22",
		"nodeType": "Sound",
		"order":

17

20,
		"type": "

NodeStart

NodeResult",
		"data": [],
		"time": "2020-05-06T08:43:

11

23+00:00"
	}, {
		"nodeId": "

collect_id

amount",
		"nodeType": "Sound",
		"order":

18

21,
		"type": "

NodeResult

NodeStart",
		"data": [],
		"time": "2020-05-06T08:43:

16

24+00:00"
	}, {
		"nodeId": "

text22

amount",
		"nodeType": "Sound",
		"order":

19

22,
		"type": "

NodeStart

NodeResult",
		"data": [],
		"time": "2020-05-06T08:43:

17

28+00:00"
	}, {
		"nodeId": "

text22

text30",
		"nodeType": "Sound",
		"order":

20

23,
		"type": "

NodeResult

NodeStart",
		"data": [],
		"time": "2020-05-06T08:43:

23

29+00:00"
	}, {
		"nodeId": "

amount

text30",
		"nodeType": "Sound",
		"order":

21

24,
		"type": "

NodeStart

NodeResult",
		"data": [],
		"time": "2020-05-06T08:43:

24

45+00:00"
	}, {
		"nodeId": "

amount

text31",
		"nodeType": "Sound",
		"order":

22

25,
		"type": "

NodeResult

NodeStart",
		"data": [],
		"time": "2020-05-06T08:43:

28

46+00:00"
	}, {
		"nodeId": "

text30

text31",
		"nodeType": "Sound",
		"order":

23

26,
		"type": "

NodeStart

NodeResult",
		"data": [],
		"time": "2020-05-06T08:

43

44:

29

07+00:00"
	}, {
		"nodeId": "

text30

businesshours",
		"nodeType": "

Sound

IsTimeInInterval",
		"order":

24

27,
		"type": "

NodeResult

NodeStart",
		"data": [],
		"time": "2020-05-06T08:

43

44:

45

07+00:00"
	}, {
		"nodeId": "

text31

businesshours_forward_switch",
		"nodeType": "

Sound

CheckVariable",
		"order":

25

29,
		"type": "NodeStart",
		"data": [],
		"time": "2020-05-06T08:

43

44:

46

07+00:00"
	}, {
		"nodeId": "

text31

text40",
		"nodeType": "

Sound

DTMF",
		"order":

26

31,
		"type": "

NodeResult

NodeStart",
		"data": [],
		"time": "2020-05-06T08:44:07+00:00"
	}, {
		"nodeId": "

businesshours

text40",
		"nodeType": "

IsTimeInInterval

DTMF",
		"order":

27

32,
		"type": "

NodeStart

NodeResult",
		"data": {
			"input": [],
			"outcome": "timeout"
		},
		"time": "2020-05-06T08:44:

07

20+00:00"
	}, {
		"nodeId": "

businesshours_forward_switch

text43",
		"nodeType": "

CheckVariable

Sound",
		"order":

29

33,
		"type": "NodeStart",
		"data": [],
		"time": "2020-05-06T08:44:

07

20+00:00"
	}, {
		"nodeId": "

text40

text43",
		"nodeType": "

DTMF

Sound",
		"order":

31

34,
		"type": "

NodeStart

NodeResult",
		"data": [],
		"time": "2020-05-06T08:44:

07

32+00:00"
	}, {

"nodeId": "text40", "nodeType": "DTMF", "order": 32,

type

nodeId": "

NodeResult

text44",
		"

data

nodeType":

{

"Sound",

input

order":

[]

35,

outcome

type": "

timeout

NodeStart",

}

"data": [],
		"time": "2020-05-06T08:44:

20

32+00:00"
	}, {
		"nodeId": "

text43

text44",
		"nodeType": "Sound",
		"order":

33

36,
		"type": "

NodeStart

NodeResult",
		"data": [],
		"time": "2020-05-06T08:44:

20

36+00:00"
	}, {
		"nodeId": "

text43

text45",
		"nodeType": "

Sound

DTMF",
		"order":

34

37,
		"type": "

NodeResult

NodeStart",
		"data": [],
		"time": "2020-05-06T08:44:

32

37+00:00"
	}, {
		"nodeId": "

text44

text45",
		"nodeType": "

Sound

DTMF",
		"order":

35

38,
		"type": "

NodeStart

NodeResult",
		"data": {
			"input": [],
			"outcome": "timeout"
		},
		"time": "2020-05-06T08:44:

32

49+00:00"
	}, {
		"nodeId": "

text44

exit",
		"nodeType": "

Sound

Hangup",
		"order":

36

40,
		"type": "NodeResult",
		"data": [],
		"time": "2020-05-06T08:44

:36+00:00" }, { "nodeId": "text45", "nodeType": "DTMF", "order": 37, "type": "NodeStart", "data": [], "time

:49+00:00"
	}],
	"createdOn": "2020-05-06T08:42:48+00:00",
	"updatedOn": "2020-05-06T08:44:49+00:00",
	"answeredOn": "2020-05-06T08:

44

42:

37

54+00:00"

}, { "nodeId": "text45", "nodeType": "DTMF", "order": 38, "type": "NodeResult", "data": { "input": [], "outcome": "timeout" }, "time": "2020-05-06T08:44:49+00:00" }, { "nodeId": "exit", "nodeType": "Hangup", "order": 40, "type": "NodeResult", "data": [], "time": "2020-05-06T08:44:49+00:00" }], "createdOn": "2020-05-06T08:42:48+00:00", "updatedOn": "2020-05-06T08:44:49+00:00", "answeredOn": "2020-05-06T08:42:54

Example message for an anonymous or not recognized an inbound call

It is possible some is calling from a phone number we cannot match to a record or they have blocked their phone number.

In this case, we cannot provide the attribute reference.

Code Block

{
    "id": "94d21117-2768-498c-a401-1b17e581e441",
    "attributes": {
      "origin": "annabel",
      "customer": "1000",
      "script": "1001"
    },
    "direction": "inbound",
    "status": "finished",
    "localNumber": "31513703800",
    "remoteNumber": "anonymous",
    "events": 
      ..........
    ],
    "createdOn": "2021-05-19T12:18:25+00:00",
    "updatedOn": "2021-05-19T12:18:41+00:00",
    "answeredOn": "2021-05-19T12:18:26+00:00"
}

Version	Old Version 13	New Version Current
Changes made by	Jasper van eck (Unlicensed)	Remco Raaijmakers
Saved on	May 29, 2020	Oct 15, 2024

Page Comparison

Versions Compared

Key

Introduction

GraphQL

API endpoint

Test endpoint

API Keys

Code example

APIs

Import

Required fields

Status codes

Input options

Examples

Row Input

Query

Variables

Response

File Input

Query

Variables

Response

Search batches

Query

Variables

Response

Introduction

GraphQL

API endpoint

Test endpoint

API Keys

Code example

APIs

Import

Required fields

Status codes

Input options

Examples

Row Input

StatuscolourGreentitlePOST Query body

PayLink

Status codes

Examples

Create PayLink

Query

Variables

Variables

Response

Simple PayLink search

Query

Response Statustitle200

Variables

Response

Find single PayLink

Query

File Input

StatuscolourGreentitlePOST Query body

Variables

Response Statustitle200

Search batches

StatuscolourGreentitlePOST Query body

Variables

Response

Variables

Response Statustitle200

Advanced PayLink search

Query

PayLink

Status codes

Examples

Create PayLink

StatuscolourGreentitlePOST Query body

Variables

Variables

Response

Response Statustitle200

Simple PayLink search

StatuscolourGreentitlePOST Query body

Variables

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200

Status
colour Green
title POST
Query body

Response
Status
title 200