Skip to content

社会化观测服务 ​

上报用户当前天气反馈的接口。

请求 ​

http
GET https://api.caiyunapp.com/v1/social_observation

查询参数 ​

参数必填默认值取值范围说明
longitude是—[-180, 180]经度;缺失或非法返回 422
latitude是—[-90, 90]纬度;缺失或非法返回 422
main_info是—0~7,见 主要天气类型主要天气类型编码;后端不校验枚举取值,但缺失或非数字会返回 500,务必按表传值
sub_info是—type,level,见 次要天气类型次要天气类型,逗号分隔(多于两段时仅取前两段);后端不校验枚举取值
user_id否——用户标识 ID,第三方合作伙伴可经过哈希算法等处理后提供;缺失时以 null 记录,请求照常成功
token是——API 认证凭证,需单独开通本接口的访问权限(否则返回 401),详见 认证与鉴权
callback否——JSONP 输出

请求示例 ​

bash
curl "https://api.caiyunapp.com/v1/social_observation?longitude=116.364552&latitude=39.995280&main_info=0&sub_info=0,0&user_id={user_id}&token={token}"

主要天气类型 ​

名称编码
晴0
多云1
阴2
雨3
雪4
雾霾5
大风6
结冰7

次要天气类型 ​

名称编码级别描述
云量00万里无云
1几缕薄云
2几坨棉花
3遮天蔽日
4乌云满天
雨量10零星小雨
1淅淅沥沥
3雨水如注
5暴雨成灾
雪量20似有似无
1零星小雪
2飘落雪花
3鹅毛大雪
4暴雪纷飞
能见度31稍有薄雾
3视线受阻
5大雾
雷45电闪雷鸣
6雷暴
冰雹55冰雹来袭
沙61雾霾侵袭
3沙尘肆掠
风70无风
1微风
5风力强劲
9狂风呼啸
20龙卷风
结冰81路边结冰

响应 ​

成功时返回:

json
{ "status": "ok" }

响应字段 ​

JSONPath类型说明
$.statusstring请求状态:ok 或 failed
$.msgstring失败原因,仅失败时返回

错误 ​

失败时返回:

json
{ "status": "failed", "msg": "..." }

HTTP 状态码含义:

Status含义
400签名或 token 无效
401token 未开通本接口的访问权限
403token 被禁用、IP 不在白名单
422参数非法
429QPS 限流
500其他异常

备注 ​

  • 接口按 token 限流。
  • 每次请求会同步获取实时天气用于校正,上游异常时也可能返回 500。

彩云 App 客户端预设 ​

天气现象main_infosub_info 编码sub_info 级别
晴000
云/少云201
云/多云202
云/阴203
雨/小雨311
雨/中雨312
雨/大雨313
雪/雨夹雪321
雪/小雪421
雪/中雪422
雪/大雪423
雾霾沙尘/雾535
雾霾沙尘/霾561
雾霾沙尘/沙尘暴563
闪电345
雷暴346
冰雹355
大风675
龙卷6720
结冰781