Module: WxExt::Api::Base

Extended by:
Base
Included in:
Base
Defined in:
lib/wx_ext/api/base.rb

Overview

User api of weixin.

Author:

  • FuShengYang

Instance Method Summary collapse

Instance Method Details

#code_msg ⇒ Hash

Get weixin error_code and msg map.

Returns:

  • (Hash) —

    A json parse hash.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/wx_ext/api/base.rb', line 40

def code_msg
  {
    -1 => '系统繁忙，此时请开发者稍候再试',
    0 => '请求成功',
    40001 => '获取access_token时AppSecret错误，或者access_token无效。请开发者认真比对AppSecret的正确性，或查看是否正在为恰当的公众号调用接口',
    40002 => '不合法的凭证类型',
    40003 => '不合法的OpenID，请开发者确认OpenID（该用户）是否已关注公众号，或是否是其他公众号的OpenID',
    40004 => '不合法的媒体文件类型',
    40005 => '不合法的文件类型',
    40006 => '不合法的文件大小',
    40007 => '不合法的媒体文件id',
    40008 => '不合法的消息类型',
    40009 => '不合法的图片文件大小',
    40010 => '不合法的语音文件大小',
    40011 => '不合法的视频文件大小',
    40012 => '不合法的缩略图文件大小',
    40013 => '不合法的AppID，请开发者检查AppID的正确性，避免异常字符，注意大小写',
    40014 => '不合法的access_token，请开发者认真比对access_token的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口',
    40015 => '不合法的菜单类型',
    40016 => '不合法的按钮个数',
    40017 => '不合法的按钮个数',
    40018 => '不合法的按钮名字长度',
    40019 => '不合法的按钮KEY长度',
    40020 => '不合法的按钮URL长度',
    40021 => '不合法的菜单版本号',
    40022 => '不合法的子菜单级数',
    40023 => '不合法的子菜单按钮个数',
    40024 => '不合法的子菜单按钮类型',
    40025 => '不合法的子菜单按钮名字长度',
    40026 => '不合法的子菜单按钮KEY长度',
    40027 => '不合法的子菜单按钮URL长度',
    40028 => '不合法的自定义菜单使用用户',
    40029 => '不合法的oauth_code',
    40030 => '不合法的refresh_token',
    40031 => '不合法的openid列表',
    40032 => '不合法的openid列表长度',
    40033 => '不合法的请求字符，不能包含\uxxxx格式的字符',
    40035 => '不合法的参数',
    40038 => '不合法的请求格式',
    40039 => '不合法的URL长度',
    40050 => '不合法的分组id',
    40051 => '分组名字不合法',
    41001 => '缺少access_token参数',
    41002 => '缺少appid参数',
    41003 => '缺少refresh_token参数',
    41004 => '缺少secret参数',
    41005 => '缺少多媒体文件数据',
    41006 => '缺少media_id参数',
    41007 => '缺少子菜单数据',
    41008 => '缺少oauth code',
    41009 => '缺少openid',
    42001 => 'access_token超时，请检查access_token的有效期，请参考基础支持-获取access_token中，对access_token的详细机制说明',
    42002 => 'refresh_token超时',
    42003 => 'oauth_code超时',
    43001 => '需要GET请求',
    43002 => '需要POST请求',
    43003 => '需要HTTPS请求',
    43004 => '需要接收者关注',
    43005 => '需要好友关系',
    44001 => '多媒体文件',
    44002 => 'POST的数据包',
    44003 => '图文消息内容',
    44004 => '文本消息内容',
    45001 => '多媒体文件大小超过',
    45002 => '消息内容超过',
    45003 => '标题字段超过',
    45004 => '描述字段超过',
    45005 => '链接字段超过',
    45006 => '图片链接字段超过',
    45007 => '语音播放时间超过',
    45008 => '图文消息超过',
    45009 => '接口调用超过',
    45010 => '创建菜单个数超过',
    45015 => '回复时间超过',
    45016 => '系统分组，不允许修改',
    45017 => '分组名字过长',
    45018 => '分组数量超过上限',
    46001 => '不存在媒体数据',
    46002 => '不存在的菜单版本',
    46003 => '不存在的菜单数据',
    46004 => '不存在的用户',
    47001 => '解析JSON/XML内容错误',
    48001 => 'api功能未授权，请确认公众号已获得该接口，可以在公众平台官网-开发者中心页中查看接口权限',
    50001 => '用户未授权该api',
    61451 => '参数错误(invalid parameter)',
    61452 => '无效客服账号(invalid kf_account)',
    61453 => '客服帐号已存在(kf_account exsited)',
    61454 => '客服帐号名长度超过(仅允许10个英文字符，不包括@及@后的公众号的微信号)(invalid kf_acount length)',
    61455 => '客服帐号名包含非法字符(仅允许英文+数字)(illegal character in kf_account)',
    61456 => '客服帐号个数超过(10个客服账号)(kf_account count exceeded)',
    61457 => '无效头像文件类型(invalid file type)',
    61450 => '系统错误(system error)',
    61500 => '日期格式错误',
    61501 => '日期范围错误'
  }
end

#download_media(access_token, media_id) ⇒ Image

Download media from weixin.

Parameters:

  • access_token (Enumerable<String>)
  • media_id (Enumerable<String>)

Returns:

  • (Image) —

    Download img.



154
155
156
157
158
 
# File 'lib/wx_ext/api/base.rb', line 154

def download_media(access_token, media_id)
  url = 'http://file.api.weixin.qq.com/cgi-bin/media/get'\
        "?access_token=#{access_token}&media_id=#{media_id}"
  RestClient.get url
end

#get_access_token(appid, secret, grant_type = 'client_credential') ⇒ Hash

Get the access_token for other apis via get.

Parameters:

  • appid (Enumerable<String>)
  • secret (Enumerable<String>)
  • grant_type (Enumerable<String>) (defaults to: 'client_credential')

Returns:

  • (Hash) —

    “access_token”:“ACCESS_TOKEN”,“expires_in”:7200



21
22
23
24
25
 
# File 'lib/wx_ext/api/base.rb', line 21

def get_access_token(appid, secret, grant_type = 'client_credential')
  url = 'https://api.weixin.qq.com/cgi-bin/token'\
        "?grant_type=#{grant_type}&appid=#{appid}&secret=#{secret}"
  Helper.http_get(url, { accept: :json })
end

#get_weixin_ips(access_token) ⇒ Hash

Get weixin server ips.

Parameters:

  • access_token (Enumerable<String>)

Returns:

  • (Hash) —

    A json parse hash.



31
32
33
34
35
 
# File 'lib/wx_ext/api/base.rb', line 31

def get_weixin_ips(access_token)
  url = 'https://api.weixin.qq.com/cgi-bin/getcallbackip'\
        "?access_token=#{access_token}"
  Helper.http_get(url, { accept: :json })
end

#upload_media(access_token, type, media) ⇒ Hash

Upload media to weixin.

Parameters:

  • access_token (Enumerable<String>)
  • type (Enumerable<String>) —

    媒体文件类型，分别有图片（image）、语音（voice）、视频（video）和缩略图（thumb）

  • media (File) —

    form-data中媒体文件标识，有filename、filelength、content-type等信息

Returns:

  • (Hash) —

    “type”:“TYPE”,“media_id”:“MEDIA_ID”,“created_at”:123456789



143
144
145
146
147
 
# File 'lib/wx_ext/api/base.rb', line 143

def upload_media(access_token, type, media)
  url = 'http://file.api.weixin.qq.com/cgi-bin/media/upload'\
        "?access_token=#{access_token}&type=#{type}"
  Helper.http_post(url, {file: media})
end