サポート

/v1/support

supportノードを使用して、WhatsApp Business APIクライアントのヘルプを入手します。ダイレクトサポートチケットをオープンする方法について詳しくは、サポートへのお問い合わせをご覧ください。

取得

supportノードにAPI呼び出しを行うと、問題に対処するためにサポートチームが使用できる情報が返されます。

例

GET /v1/support

cURLを使用する場合は、次のようになります。

curl  https://your-webapp-hostname:your-webapp-port/v1/support \
  -H 'Authorization: Bearer your-auth-token' 

成功した場合の応答には、WhatsApp Business APIクライアントに関するデータが含まれています。応答のフィールドは、インストール環境によって次のように異なります。

単一インスタンス

{
    "support": {   
        "context": "healthcheck", # context of the API
        "db_engine": "MYSQL"
        "db_info": [ database-driver-version ],
        "debug_info": "business-phone-number", #phone number if registered, otherwise, unregistered
        "description": "whatsapp-build-version",
        "device_iso8601": "current-timestamp",
  
        "e2e": { # encryption debug info
            "identity_timestamp": "id-timestamp",
            "registration_id": registration-id
        },
  
        "env": [ client-env-variables ],
        "expire_timestamp": "2018-09-27T14:26:07", # app build version expires timestamp 
        "free_space_data": 9223372036853727000, # bytes available on the data directory  
        "free_space_logs": 14269902848, # bytes available on the log directory
        "free_space_media_incoming": 9223372036853727000, # bytes available on the media incoming directory
        "free_space_media_outgoing": 9223372036853727000, # bytes available on the media outgoing directory
        "lc": "en", # lowercase, two-letter ISO 639 language code, ZZ if code is unknown
        "lg": "US", # uppercase, two or three-letter ISO 3166 country code, ZZ if code is unknown
        "multi_connect": false, # specifies whether current client is multiconnect enabled 
        "os_name": "ubuntu-x86_64", # operating system name 
        "os_version": "16.04", # operating system version

        "schema": { # database schema versions
            "axolotl": 1,
            "callback": 2,
            "cluster": 3,
            "config": 4,
            "contact": 5,
            "jobqueue": 6,
            "message": 7
        },
        "socket_conn": "UP | DN" | "SC" | "UP receiving offline" | "UNK", # see options below
        "version": "build-version"    
    }
}

高可用性/マルチコネクト

{
    "support": {
        "your-hostname1:your-container-id1": {
          "multi_connect" : true,
          "role": "primary_master | secondary_master | coreapp",
          "shards": [ [your-owned-shard-id, your-owned-shard-id], ...],
          "context": "healthcheck",
          "db_engine": "MYSQL | PGSQL",
          "db_info": [ ... ],
          "debug_info": "enterprise phone number",
          "description": "build information",
          ...
        },
        "your-hostname2:your-container-id2": {
          "multi_connect" : true,
          "role": "primary_master | secondary_master | coreapp",
          "shards": [ [your-owned-shard-id, your-owned-shard-id], ...],
          "context": "healthcheck",
          "db_engine": "MYSQL | PGSQL",
          "db_info": [ ... ],
          "debug_info": "enterprise phone number",
          "description": "build information",
          ...
        },
    }
}

パラメーター

socket_connフィールド

socket_connフィールドには、WhatsAppサーバーへの現在の接続状況が示されます。

shardsフィールド

• 高可用性では、1つのCoreappだけが、コントロールシャード(-1)と通常シャード(0)の両方を所有します。そのシャードフィールドは[[-1, -1], [0, 0]]になり、他のノードのシャードフィールドは[]になります。
• マルチコネクトでは、プライマリマスターがコントロールシャード(-1)を所有し、そのシャードフィールドは[[-1, -1]]になります。シャードを所有するCoreappのシャードフィールドは、[[owned-shard-id,owned shard id]]になります。現在のところ、1つのCoreappが一度に所有できるシャードは1つだけです。

roleフィールド