ReportPayload.php 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. <?php
  2. namespace JPush;
  3. use InvalidArgumentException;
  4. class ReportPayload {
  5. private static $EFFECTIVE_TIME_UNIT = array('HOUR', 'DAY', 'MONTH');
  6. private $client;
  7. /**
  8. * ReportPayload constructor.
  9. * @param $client JPush
  10. */
  11. public function __construct($client)
  12. {
  13. $this->client = $client;
  14. }
  15. public function getReceived($msgIds) {
  16. $queryParams = '?msg_ids=';
  17. if (is_array($msgIds) && !empty($msgIds)) {
  18. $msgIdsStr = implode(',', $msgIds);
  19. $queryParams .= $msgIdsStr;
  20. } elseif (is_string($msgIds)) {
  21. $queryParams .= $msgIds;
  22. } else {
  23. throw new InvalidArgumentException("Invalid msg_ids");
  24. }
  25. $url = $this->client->makeURL('report') . 'received' . $queryParams;
  26. return Http::get($this->client, $url);
  27. }
  28. /*
  29. 送达统计详情(新)
  30. https://docs.jiguang.cn/jpush/server/push/rest_api_v3_report/#_7
  31. */
  32. public function getReceivedDetail($msgIds) {
  33. $queryParams = '?msg_ids=';
  34. if (is_array($msgIds) && !empty($msgIds)) {
  35. $msgIdsStr = implode(',', $msgIds);
  36. $queryParams .= $msgIdsStr;
  37. } elseif (is_string($msgIds)) {
  38. $queryParams .= $msgIds;
  39. } else {
  40. throw new InvalidArgumentException("Invalid msg_ids");
  41. }
  42. $url = $this->client->makeURL('report') . 'received/detail' . $queryParams;
  43. return Http::get($this->client, $url);
  44. }
  45. public function getMessageStatus($msgId, $rids, $data = null) {
  46. $url = $this->client->makeURL('report') . 'status/message';
  47. $registrationIds = is_array($rids) ? $rids : array($rids);
  48. $body = [
  49. 'msg_id' => $msgId,
  50. 'registration_ids' => $registrationIds
  51. ];
  52. if (!is_null($data)) {
  53. $body['data'] = $data;
  54. }
  55. return Http::post($this->client, $url, $body);
  56. }
  57. public function getMessages($msgIds) {
  58. $queryParams = '?msg_ids=';
  59. if (is_array($msgIds) && !empty($msgIds)) {
  60. $msgIdsStr = implode(',', $msgIds);
  61. $queryParams .= $msgIdsStr;
  62. } elseif (is_string($msgIds)) {
  63. $queryParams .= $msgIds;
  64. } else {
  65. throw new InvalidArgumentException("Invalid msg_ids");
  66. }
  67. $url = $this->client->makeURL('report') . 'messages/' .$queryParams;
  68. return Http::get($this->client, $url);
  69. }
  70. /*
  71. 消息统计详情(VIP 专属接口,新)
  72. https://docs.jiguang.cn/jpush/server/push/rest_api_v3_report/#vip_1
  73. */
  74. public function getMessagesDetail($msgIds) {
  75. $queryParams = '?msg_ids=';
  76. if (is_array($msgIds) && !empty($msgIds)) {
  77. $msgIdsStr = implode(',', $msgIds);
  78. $queryParams .= $msgIdsStr;
  79. } elseif (is_string($msgIds)) {
  80. $queryParams .= $msgIds;
  81. } else {
  82. throw new InvalidArgumentException("Invalid msg_ids");
  83. }
  84. $url = $this->client->makeURL('report') . 'messages/detail' .$queryParams;
  85. return Http::get($this->client, $url);
  86. }
  87. public function getUsers($time_unit, $start, $duration) {
  88. $time_unit = strtoupper($time_unit);
  89. if (!in_array($time_unit, self::$EFFECTIVE_TIME_UNIT)) {
  90. throw new InvalidArgumentException('Invalid time unit');
  91. }
  92. $url = $this->client->makeURL('report') . 'users/?time_unit=' . $time_unit . '&start=' . $start . '&duration=' . $duration;
  93. return Http::get($this->client, $url);
  94. }
  95. }