README

このドキュメントについて

このドキュメントは、XoxzoのAPIドキュメンテーションにおける基本や共通となるものを紹介のため作られたものです。

一般的なご利用

リスエストが成功したかどうかを示すために、APIは標準HTTPエラーコードを使います。成功の場合には 200 または 201 のような 2xx を、失敗の場合にはそれ以外、となります。

例として、もしエンドポイントへ、こういったリクエストをした場合

https://api.xoxzo.com/voice/simple/playback/

成功し、処理が引き受けられた場合、こういったレスポンスが得られます。

HTTP/1.0 201 CREATED

反対に、リクエストが有効でなく、処理を引き受けられなかった場合、 400 などの、200エラーでないエラーコードを受け取ることになります。そして、レスポンス中には、例えば下記のような、さらなる情報が含まれることとなります。

HTTP/1.0 400 BAD REQUEST
Content-Type: application/json

{
    "recording_url": [
        "This field is required."
        ]
}