:orphan:

channel服务（WebSocket）
----------------------------------------

.. http:post:: /channel/v1/create_channel

    创建一个WebSocket连接，返回的数据格式是JSON，其中包含连接的地址，请注意这个连接地址只能接收下行信息，上行需要通过下述的send_message接口发送。

POST的参数列表：

   =========  =============================  =======================
   参数               支持的值                    说明
   =========  =============================  =======================
   client_id      通道的标示，数字字符组合         唯一
   duration       通道的过期时间                  单位是秒，最大3600
   =========  =============================  =======================

输入参数示例：

.. sourcecode:: text

    $post_data = array();
    $post_data['client_id'] = 'client-1';
    $post_data['duration'] = 3600;

返回参数示例：

.. sourcecode:: text

    {"data":"ws://channel.sinaapp.com/com/48HcoN529Ok9OSdROkrJPeN1t0fAVUz_FV15mnJab4X5CxMqBop-Z_lfSQUcTA8x93frndyBiJGqcCBPi2yEuw"}


返回的参数是一个数组，data字段中包含了websocket的连接地址，如果需要使用 **HTTPS** ，请修改ws为wss。


.. http:post:: /channel/v1/send_message

    往一个WebSocket连接中推送消息。

POST的参数列表：

   ============  =========================  ============================================================================
   参数               支持的值                   说明
   ============  =========================  ============================================================================
   client_id      通道的标示，数字字符组合       和创建时一致，例如client-1
   message        需要推送的消息                不能为空，最大可以发送4k的消息
   async          0或者1                       是否异步发送，如果设置为1，服务端会立刻返回（始终返回成功），默认为0
   ============  =========================  ============================================================================

输入参数示例：

.. sourcecode:: text

    $post_data = array();
    $post_data['client_id'] = 'client-1';
    $post_data['message'] = '消息发送';
    $post_data['async'] = 0;

返回参数示例：

.. sourcecode:: text

    {"data":1}


返回的参数是一个数组，data字段标示是否发送成功，1表示成功。

`Channel服务PHP示例程序代码 <https://github.com/sinacloud/websocket-gapi-example>`_