YQueue DocsDevelopers

Schema

Phone Number

The standardised representation of a phone number. As a general rule of thumb for displaying mobile numbers: - If country matches the merchant/outlet's country, use national_number - If country does not match the merchant/outlet's country, use international_number

  • Foundation

Overview

object · 5 properties · 2 required

Properties

country

string Required

The ISO 3166-1 alpha-2 associated with the phone number.

Example SG
Min length 2
Max length 2

country_calling_code

string

The calling code associated with the phone number.

Example +65
Min length 2
Max length 4
Read only Yes

national_number

string Required

The localised (national) representation of the phone number.

Example 6904 4827
Min length 1
Max length 255

international_number

string

The localised (international) representation of the phone number.

Example +65 6904 4827
Read only Yes

e_164

string

The e.164 formatted representation of the phone number.

Example +6569044827
Min length 1
Max length 15
Read only Yes

Used by

Raw YAML
Download source
title: Phone Number
x-tags:
  - Foundation
type: object
description: |-
  The standardised representation of a phone number.

  As a general rule of thumb for displaying mobile numbers:

  - If `country` _matches_ the merchant/outlet's country, use `national_number`
  - If `country` _does not match_ the merchant/outlet's country, use `international_number`
required:
  - country
  - national_number
properties:
  country:
    type: string
    description: The ISO 3166-1 alpha-2 associated with the phone number.
    example: SG
    minLength: 2
    maxLength: 2
  country_calling_code:
    type: string
    description: The calling code associated with the phone number.
    example: '+65'
    minLength: 2
    maxLength: 4
    readOnly: true
  national_number:
    type: string
    example: 6904 4827
    description: The localised (national) representation of the phone number.
    minLength: 1
    maxLength: 255
  international_number:
    type: string
    description: The localised (international) representation of the phone number.
    example: +65 6904 4827
    readOnly: true
  e_164:
    type: string
    example: '+6569044827'
    description: The e.164 formatted representation of the phone number.
    minLength: 1
    maxLength: 15
    readOnly: true

Search documentation

Search across this documentation site.