フィードを取得
niwango Open API の仕様
目次
Open API version 1.0
概要
OpenAPIは、ニワンゴのコマンドを拡張するものです。
コマンドを追加したいデベロッパーはニワンゴ社に対して対応するコマンドキーワード、リクエストURLを登録します。
エンドユーザからのメールによるリクエストはニワンゴ本体(core)によりコマンド、パラメータとして解釈され、登録されたコマンドキーワードに応じたリクエストURLにいくつかのパラメータを付与したHTTP POSTリクエストが送られます。
OpenAPIを実装するコンテンツは、このPOSTリクエストに応じて処理結果をテキストで返します。
ニワンゴ本体(core)はこのAPIによって返されたテキストをメール本文としてエンドユーザに送信します。
機能
- テキストメールの返信
- 絵文字の付加
- デコトメールでの返信
- 画像の添付
- 送信元の識別(ユーザIDで通知)
サンプル
ユーザからのメール
Subject: (なし) To: m@open.niwango.jp国名 アメリカ
APIリクエスト:
ttp://example.com/openapi.php?uid=AbCdEfghIjkLMnoPqRStUv&carrier=docomo&to=m@open.niwango.jp&c=%8D%91%96%BC&p1=%83A%83%81%83%8A%83J
uid=AbCdEfghIjkLMnoPqRStUv carrier = docomo to=m@open.niwango.jp c = 国名 p1=アメリカ
APIリプライ:
subject=国名 アメリカ body=アメリカの漢字は 亜米利加ベトナムは知ってる?
ユーザに届くメール
Subject: 国名 アメリカ
From: m@open.niwango.jpミ(ﾟθﾟ)彡
こんにちはニワンゴです｡アメリカの漢字は 亜米利加
ベトナムは知ってる?
ではではー
リクエスト
HTTP POST
文字コード: SJIS
| リクエストパラメータ | 値 | 説明 |
|---|---|---|
| uid | string | エンドユーザのユーザID。22バイトの英数文字で、エンドユーザの携帯メールアドレスと1:1で対応しています(通称イカハッシュ) |
| to | string | エンドユーザがTo:に指定したメールアドレス。通常は m@open.niwango.jp です。 |
| carrier | string | エンドユーザの携帯キャリア。docomo/kddi/vodafone/willcomのいずれか。メールアドレスから判別されます |
| c | string | 反応したコマンドキーワード、URLエンコードされています。 |
| p1 | string | 付与されたパラメータ(1番目)、URLエンコードされています。 |
| p2 | string | 付与されたパラメータ(2番目)、URLエンコードされています。 |
| p3 | string | 付与されたパラメータ(3番目)、URLエンコードされています。 |
| p4 | string | 付与されたパラメータ(4番目)、URLエンコードされています。 |
| n | string | Re:のカウンタ Re:なし…1 Re: またはRe2:…2(本文があるばあいはすべて1) |
| from | string | 将来のために予約。実際は付与されない |
| subject | string | subject全体 |
| body | string | body全部(署名も含)。引用含めない |
| p_body | string | body全部(署名も含)。引用含む |
リプライ
文字コード: SJIS
改行コード: \r\n(CRLF)
| レスポンスパラメータ | 値 | 説明 |
|---|---|---|
| subject | string | [任意]返信されるメールの件名 |
| filepath | string | [任意]添付されるファイルのパス。httpのURLを記述します |
| from | string | [任意]返信されるメールのfromに書くメールアドレス。デフォルトはm@open.niwango.jp。かまいたちなどに使用します。 |
| delay | int | [任意]送信する予定の時間。YYYYMMD DHHmmの形式 |
| response | string | [任意]返信されるメールの検索結果、省略時SUCCESS（SUCCESS:成功、NO_HIT:検索ヒットなし、ERROR:エラー、NOT_SEND:メール送信なし） |
| deco | string | HTMLパート部分。複数行可。1行が996byte以上はDoCoMoで送信できない場合があります。 |
| body | string | 返信されるメールの本文。decoが指定されている場合は、テキストパートになります。必ず最後のパラメータにします。1行が996byte以上はDoCoMoで送信できない場合があります。 |
| decoimg | string | デコメール 用画像（cid;画像URL） |
最もシンプルなレスポンスの例
body=こんにちは。元気？
バックエンドで送信するレスポンスの例
response=NOT_SEND