ساخت سرور برنامه درخواست ارسال

با استفاده از Firebase Admin SDK یا پروتکل‌های سرور برنامه FCM ، می‌توانید درخواست‌های پیام بسازید و آنها را به این نوع اهداف ارسال کنید:

• نام موضوع
• وضعیت
• رمز ثبت دستگاه
• نام گروه دستگاه (فقط پروتکل)

می‌توانید پیام‌هایی را با یک محموله اعلان متشکل از فیلدهای از پیش تعریف‌شده، یک محموله داده از فیلدهای تعریف‌شده توسط کاربر یا پیامی حاوی هر دو نوع بار ارسال کنید. برای اطلاعات بیشتر به انواع پیام مراجعه کنید.

مهم: درخواست‌های ارسال برای Firebase Admin SDK و v1 HTTP باید حاوی شناسه پروژه پروژه Firebase برای برنامه شما باشد که در برگه تنظیمات پروژه عمومی کنسول Firebase موجود است. همچنین، برای هر دو روش ارسال پیام، شما باید درخواست‌های ارسال را مجاز کنید .

مثال‌های موجود در این صفحه نحوه ارسال پیام‌های اعلان را با استفاده از Firebase Admin SDK (که از Node ، Java ، Python ، C# و Go پشتیبانی می‌کند) و پروتکل HTTP v1 نشان می‌دهد.

احتیاط: ارسال پیام‌ها (از جمله پیام‌های بالادست) با APIهای قدیمی FCM XMPP و HTTP در 20 ژوئن 2023 منسوخ شد و از ژوئن 2024 حذف خواهد شد . اگر از APIهای ارسال FCM قدیمی استفاده می‌کنید، اکیداً توصیه می‌کنیم به API HTTP v1 مهاجرت کنید یا از Admin SDK برای ایجاد درخواست‌های ارسال استفاده کنید.

ارسال پیام به دستگاه های خاص

برای ارسال به یک دستگاه خاص، رمز ثبت نام دستگاه را مطابق شکل ارسال کنید. برای کسب اطلاعات بیشتر در مورد نشانه های ثبت نام، اطلاعات راه اندازی مشتری برای پلتفرم خود را ببینید.

Node.js

// This registration token comes from the client FCM SDKs.
const registrationToken = 'YOUR_REGISTRATION_TOKEN';

const message = {
  data: {
    score: '850',
    time: '2:45'
  },
  token: registrationToken
};

// Send a message to the device corresponding to the provided
// registration token.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

جاوا

// This registration token comes from the client FCM SDKs.
String registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setToken(registrationToken)
    .build();

// Send a message to the device corresponding to the provided
// registration token.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
FirebaseMessagingSnippets.java

پایتون

# This registration token comes from the client FCM SDKs.
registration_token = 'YOUR_REGISTRATION_TOKEN'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    token=registration_token,
)

# Send a message to the device corresponding to the provided
# registration token.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
cloud_messaging.py

برو

// Obtain a messaging.Client from the App.
ctx := context.Background()
client, err := app.Messaging(ctx)
if err != nil {
	log.Fatalf("error getting Messaging client: %v\n", err)
}

// This registration token comes from the client FCM SDKs.
registrationToken := "YOUR_REGISTRATION_TOKEN"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Token: registrationToken,
}

// Send a message to the device corresponding to the provided
// registration token.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
messaging.go

سی شارپ

// This registration token comes from the client FCM SDKs.
var registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Token = registrationToken,
};

// Send a message to the device corresponding to the provided
// registration token.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
      "notification":{
        "body":"This is an FCM notification message!",
        "title":"FCM Message"
      }
   }
}

دستور cURL:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "notification":{
     "title":"FCM Message",
     "body":"This is an FCM Message"
   },
   "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

در صورت موفقیت، هر روش ارسال یک شناسه پیام را برمی گرداند. Firebase Admin SDK رشته ID را در قالب projects/{project_id}/messages/{message_id} برمی‌گرداند. پاسخ پروتکل HTTP یک کلید JSON است:

    {
      "name":"projects/myproject-b5ae1/messages/0:1500415314455276%31bd1c9631bd1c96"
    }

ارسال پیام به چندین دستگاه

مهم: روش‌های ارسال شرح‌داده‌شده در این بخش در تاریخ 21 ژوئن 2023 منسوخ شده‌اند و در ژوئن 2024 حذف خواهند شد. برای پروتکل، به جای پروتکل، از روش ارسال استاندارد HTTP v1 API استفاده کنید، ارسال دسته‌ای خود را با تکرار فهرست گیرندگان و ارسال به توکن هر گیرنده اجرا کنید. برای روش‌های Admin SDK، حتماً به نسخه اصلی بعدی به‌روزرسانی کنید. برای اطلاعات بیشتر به سؤالات متداول Firebase مراجعه کنید.

Admin FCM APIs به شما امکان می دهد پیام را به لیستی از نشانه های ثبت دستگاه چندپخش کنید. شما می توانید تا 500 توکن ثبت دستگاه را در هر فراخوانی مشخص کنید.

Node.js

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
};

getMessaging().sendMulticast(message)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });

جاوا

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");
FirebaseMessagingSnippets.java

پایتون

# Create a list containing up to 500 registration tokens.
# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))
cloud_messaging.py

برو

// Create a list containing up to 500 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)
messaging.go

سی شارپ

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachForMulticastAsync(message);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");
FirebaseMessagingSnippets.cs

مقدار بازگشتی لیستی از نشانه ها است که با ترتیب توکن های ورودی مطابقت دارد. این زمانی مفید است که می‌خواهید بررسی کنید کدام نشانه‌ها منجر به خطا شده‌اند.

Node.js

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
};

getMessaging().sendMulticast(message)
  .then((response) => {
    if (response.failureCount > 0) {
      const failedTokens = [];
      response.responses.forEach((resp, idx) => {
        if (!resp.success) {
          failedTokens.push(registrationTokens[idx]);
        }
      });
      console.log('List of tokens that caused failures: ' + failedTokens);
    }
  });

جاوا

// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
if (response.getFailureCount() > 0) {
  List<SendResponse> responses = response.getResponses();
  List<String> failedTokens = new ArrayList<>();
  for (int i = 0; i < responses.size(); i++) {
    if (!responses.get(i).isSuccessful()) {
      // The order of responses corresponds to the order of the registration tokens.
      failedTokens.add(registrationTokens.get(i));
    }
  }

  System.out.println("List of tokens that caused failures: " + failedTokens);
}
FirebaseMessagingSnippets.java

پایتون

# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
if response.failure_count > 0:
    responses = response.responses
    failed_tokens = []
    for idx, resp in enumerate(responses):
        if not resp.success:
            # The order of responses corresponds to the order of the registration tokens.
            failed_tokens.append(registration_tokens[idx])
    print('List of tokens that caused failures: {0}'.format(failed_tokens))
cloud_messaging.py

برو

// Create a list containing up to 500 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

if br.FailureCount > 0 {
	var failedTokens []string
	for idx, resp := range br.Responses {
		if !resp.Success {
			// The order of responses corresponds to the order of the registration tokens.
			failedTokens = append(failedTokens, registrationTokens[idx])
		}
	}

	fmt.Printf("List of tokens that caused failures: %v\n", failedTokens)
}
messaging.go

سی شارپ

// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachForMulticastAsync(message);
if (response.FailureCount > 0)
{
    var failedTokens = new List<string>();
    for (var i = 0; i < response.Responses.Count; i++)
    {
        if (!response.Responses[i].IsSuccess)
        {
            // The order of responses corresponds to the order of the registration tokens.
            failedTokens.Add(registrationTokens[i]);
        }
    }

    Console.WriteLine($"List of tokens that caused failures: {failedTokens}");
}
FirebaseMessagingSnippets.cs

ارسال پیام به موضوعات

پس از ایجاد یک موضوع، یا با اشتراک نمونه‌های برنامه مشتری در موضوع سمت سرویس گیرنده یا از طریق API سرور ، می‌توانید پیام‌هایی را به موضوع ارسال کنید. اگر این اولین باری است که درخواست ارسال درخواست برای FCM را ایجاد می‌کنید، راهنمای محیط سرور و FCM را برای اطلاعات مهم پس‌زمینه و راه‌اندازی ببینید.

در منطق ارسال خود در باطن، نام موضوع مورد نظر را مطابق شکل مشخص کنید:

Node.js

// The topic name can be optionally prefixed with "/topics/".
const topic = 'highScores';

const message = {
  data: {
    score: '850',
    time: '2:45'
  },
  topic: topic
};

// Send a message to devices subscribed to the provided topic.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

جاوا

// The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setTopic(topic)
    .build();

// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
FirebaseMessagingSnippets.java

پایتون

# The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    topic=topic,
)

# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
cloud_messaging.py

برو

// The topic name can be optionally prefixed with "/topics/".
topic := "highScores"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Topic: topic,
}

// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
messaging.go

سی شارپ

// The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Topic = topic,
};

// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
    "topic" : "foo-bar",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message"
      }
   }
}

دستور cURL:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "message": {
    "topic" : "foo-bar",
    "notification": {
      "body": "This is a Firebase Cloud Messaging Topic Message!",
      "title": "FCM Message"
    }
  }
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

برای ارسال پیام به ترکیبی از موضوعات، یک شرط را مشخص کنید، که یک عبارت بولی است که موضوعات مورد نظر را مشخص می کند. برای مثال، شرایط زیر پیام‌هایی را به دستگاه‌هایی ارسال می‌کند که مشترک TopicA و TopicB یا TopicC هستند:

"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"

FCM ابتدا هر شرایط داخل پرانتز را ارزیابی می کند و سپس عبارت را از چپ به راست ارزیابی می کند. در عبارت بالا، کاربری که در یک موضوع مشترک است، پیامی را دریافت نمی کند. به همین ترتیب، کاربری که در TopicA مشترک نمی شود، پیام را دریافت نمی کند. این ترکیب ها آن را دریافت می کنند:

• TopicA و TopicB
• TopicA و TopicC

می توانید حداکثر پنج موضوع را در عبارت شرطی خود بگنجانید.

برای ارسال به یک شرط:

Node.js

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
const condition = '\'stock-GOOG\' in topics || \'industry-tech\' in topics';

// See documentation on defining a message payload.
const message = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  condition: condition
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

جاوا

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
Message message = Message.builder()
    .setNotification(Notification.builder()
        .setTitle("$GOOG up 1.43% on the day")
        .setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
        .build())
    .setCondition(condition)
    .build();

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
FirebaseMessagingSnippets.java

پایتون

# Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"

# See documentation on defining a message payload.
message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    condition=condition,
)

# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
cloud_messaging.py

برو

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Condition: condition,
}

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
messaging.go

سی شارپ

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
var message = new Message()
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Condition = condition,
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
   "message":{
    "condition": "'dogs' in topics || 'cats' in topics",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message",
    }
  }
}

دستور cURL:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "notification": {
    "title": "FCM Message",
    "body": "This is a Firebase Cloud Messaging Topic Message!",
  },
  "condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

ارسال پیام به گروه های دستگاه

برای ارسال پیام به گروه های دستگاه، از HTTP v1 API استفاده کنید. اگر در حال حاضر با استفاده از APIهای ارسال قدیمی قدیمی برای HTTP یا XMPP یا هر یک از نسخه‌های قدیمی‌تر Firebase Admin SDK برای Node.js بر اساس پروتکل‌های قدیمی، به گروه‌های دستگاه ارسال می‌کنید، اکیداً توصیه می‌کنیم در اولین فرصت به API HTTP v1 مهاجرت کنید . APIهای ارسال قدیمی در ژوئن 2024 غیرفعال و حذف خواهند شد.

ارسال پیام به یک گروه دستگاه بسیار شبیه به ارسال پیام به یک دستگاه جداگانه است، با استفاده از همان روش برای تأیید درخواست‌های ارسال . فیلد token را روی کلید اعلان گروه تنظیم کنید:

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ",
      "data":{
        "hello": "This is a Firebase Cloud Messaging device group message!"
      }
   }
}

دستور cURL

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "data":{
     "hello": "This is a Firebase Cloud Messaging device group message!"
   },
   "token":"APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ"
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

توجه: برخلاف روش‌های ارسال گروه دستگاه در APIهای قدیمی منسوخ، پاسخ HTTP v1 شامل شمارش موفقیت و شکست نیست. ارسال موفقیت آمیز یک پاسخ خالی برمی گرداند.

یک دسته پیام بفرستید

مهم: روش‌های ارسال دسته‌ای شرح‌داده‌شده در این بخش در تاریخ 21 ژوئن 2023 منسوخ شده‌اند و در ژوئن 2024 حذف خواهند شد. برای پروتکل، به جای پروتکل، از روش ارسال استاندارد HTTP v1 API استفاده کنید، ارسال دسته‌ای خود را با تکرار فهرست گیرندگان و ارسال به توکن هر گیرنده اجرا کنید. برای روش‌های Admin SDK، حتماً به نسخه اصلی بعدی به‌روزرسانی کنید. برای اطلاعات بیشتر به سؤالات متداول Firebase مراجعه کنید.

Admin SDK از ارسال پیام‌ها به صورت دسته‌ای پشتیبانی می‌کند. شما می توانید حداکثر 500 پیام را در یک دسته گروه بندی کنید و همه آنها را در یک تماس API ارسال کنید، با بهبود عملکرد قابل توجهی نسبت به ارسال درخواست های HTTP جداگانه برای هر پیام.

از این ویژگی می توان برای ایجاد مجموعه ای سفارشی از پیام ها و ارسال آنها به گیرندگان مختلف، از جمله موضوعات یا نشانه های ثبت دستگاه خاص استفاده کرد. از این ویژگی زمانی استفاده کنید که، برای مثال، نیاز دارید به طور همزمان پیام هایی را با جزئیات کمی متفاوت در متن پیام به مخاطبان مختلف ارسال کنید.

Node.js

// Create a list containing up to 500 messages.
const messages = [];
messages.push({
  notification: { title: 'Price drop', body: '5% off all electronics' },
  token: registrationToken,
});
messages.push({
  notification: { title: 'Price drop', body: '2% off all books' },
  topic: 'readers-club',
});

getMessaging().sendAll(messages)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });

جاوا

// Create a list containing up to 500 messages.
List<Message> messages = Arrays.asList(
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("5% off all electronics")
            .build())
        .setToken(registrationToken)
        .build(),
    // ...
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("2% off all books")
            .build())
        .setTopic("readers-club")
        .build()
);

BatchResponse response = FirebaseMessaging.getInstance().sendAll(messages);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");
FirebaseMessagingSnippets.java

پایتون

# Create a list containing up to 500 messages.
messages = [
    messaging.Message(
        notification=messaging.Notification('Price drop', '5% off all electronics'),
        token=registration_token,
    ),
    # ...
    messaging.Message(
        notification=messaging.Notification('Price drop', '2% off all books'),
        topic='readers-club',
    ),
]

response = messaging.send_all(messages)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))
cloud_messaging.py

برو

// Create a list containing up to 500 messages.
messages := []*messaging.Message{
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "5% off all electronics",
		},
		Token: registrationToken,
	},
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "2% off all books",
		},
		Topic: "readers-club",
	},
}

br, err := client.SendAll(context.Background(), messages)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)
messaging.go

سی شارپ

// Create a list containing up to 500 messages.
var messages = new List<Message>()
{
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "5% off all electronics",
        },
        Token = registrationToken,
    },
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "2% off all books",
        },
        Topic = "readers-club",
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachAsync(messages);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");
FirebaseMessagingSnippets.cs

ارسال پیام‌های مستقیم با قابلیت بوت (فقط اندروید)

می‌توانید با استفاده از HTTP v1 یا APIهای قدیمی HTTP، پیام‌ها را در حالت بوت مستقیم به دستگاه‌ها ارسال کنید. قبل از ارسال به دستگاه‌ها در حالت بوت مستقیم، مطمئن شوید که مراحل فعال کردن دستگاه‌های سرویس گیرنده را برای دریافت پیام‌های FCM در حالت راه‌اندازی مستقیم انجام داده‌اید.

احتیاط: مهم است که قابلیت مشاهده پیام‌های فعال شده مستقیم را در نظر بگیرید. هر کاربر با دسترسی به دستگاه می تواند این پیام ها را بدون وارد کردن اطلاعات کاربری مشاهده کند.

ارسال با استفاده از FCM v1 HTTP API

درخواست پیام باید شامل کلید "direct_boot_ok" : true در گزینه های AndroidConfig بدنه درخواست باشد. به عنوان مثال:

https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
  "message":{
    "token" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
    "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "android": {
      "direct_boot_ok": true,
    },
}

سفارشی کردن پیام ها در پلتفرم ها

Firebase Admin SDK و پروتکل FCM v1 HTTP هر دو به درخواست های پیام شما اجازه می دهند تمام فیلدهای موجود در شی message را تنظیم کنند. این شامل:

• مجموعه ای مشترک از فیلدها که باید توسط همه نمونه های برنامه ای که پیام را دریافت می کنند تفسیر شوند.
• مجموعه‌هایی از فیلدهای مخصوص پلتفرم، مانند AndroidConfig و WebpushConfig ، که فقط توسط نمونه‌های برنامه‌ای که در پلتفرم مشخص‌شده اجرا می‌شوند تفسیر می‌شوند.

بلوک‌های مخصوص پلتفرم به شما انعطاف‌پذیری می‌دهند تا پیام‌ها را برای پلتفرم‌های مختلف سفارشی کنید تا اطمینان حاصل کنید که هنگام دریافت به‌درستی با آنها برخورد می‌شود. پشتیبان FCM تمام پارامترهای مشخص شده را در نظر می گیرد و پیام را برای هر پلتفرم سفارشی می کند.

زمان استفاده از فیلدهای مشترک

وقتی هستید از فیلدهای مشترک استفاده کنید:

• هدف قرار دادن نمونه های برنامه در همه پلتفرم ها - اپل، اندروید و وب
• ارسال پیام به موضوعات

همه نمونه های برنامه، صرف نظر از پلتفرم، می توانند فیلدهای مشترک زیر را تفسیر کنند:

• message.notification.title
• message.notification.body
• message.data

زمان استفاده از فیلدهای مخصوص پلتفرم

زمانی که می خواهید از فیلدهای مخصوص پلتفرم استفاده کنید:

• فیلدها را فقط به پلتفرم های خاص ارسال کنید
• علاوه بر فیلدهای مشترک، فیلدهای مخصوص پلتفرم را ارسال کنید

هر زمان که می‌خواهید مقادیر را فقط به پلتفرم‌های خاصی ارسال کنید، از فیلدهای مشترک استفاده نکنید . از فیلدهای مخصوص پلتفرم استفاده کنید. به عنوان مثال، برای ارسال نوتیفیکیشن فقط به پلتفرم‌های اپل و وب اما نه برای اندروید، باید از دو مجموعه فیلد جداگانه، یکی برای اپل و دیگری برای وب استفاده کنید.

وقتی پیام هایی با گزینه های تحویل خاص ارسال می کنید، از فیلدهای مخصوص پلتفرم برای تنظیم آنها استفاده کنید. در صورت تمایل می توانید مقادیر مختلفی را برای هر پلتفرم مشخص کنید. با این حال، حتی زمانی که می‌خواهید اساساً مقدار یکسانی را در بین پلتفرم‌ها تنظیم کنید، باید از فیلدهای مخصوص پلتفرم استفاده کنید. این به این دلیل است که هر پلتفرم ممکن است مقدار را کمی متفاوت تفسیر کند - برای مثال، زمان برای زندگی در Android به عنوان زمان انقضا بر حسب ثانیه تنظیم می شود، در حالی که در اپل به عنوان تاریخ انقضا تنظیم می شود.

مثال: پیام اعلان با گزینه های رنگ و نماد

این درخواست ارسال مثال، عنوان و محتوای اعلان مشترک را به همه پلتفرم‌ها ارسال می‌کند، اما برخی موارد لغو خاص پلتفرم را نیز به دستگاه‌های Android ارسال می‌کند.

برای اندروید، درخواست یک نماد و رنگ خاص را برای نمایش در دستگاه های اندرویدی تنظیم می کند. همانطور که در مرجع AndroidNotification اشاره شد، رنگ با فرمت #rrggbb مشخص شده است و تصویر باید یک منبع نماد قابل ترسیم محلی برای برنامه Android باشد.

در اینجا تقریبی از جلوه بصری روی دستگاه کاربر آورده شده است:

Node.js

const topicName = 'industry-tech';

const message = {
  notification: {
    title: '`$FooCorp` up 1.43% on the day',
    body: 'FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  android: {
    notification: {
      icon: 'stock_ticker_update',
      color: '#7e55c3'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

جاوا

Message message = Message.builder()
    .setNotification(Notification.builder()
        .setTitle("$GOOG up 1.43% on the day")
        .setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
        .build())
    .setAndroidConfig(AndroidConfig.builder()
        .setTtl(3600 * 1000)
        .setNotification(AndroidNotification.builder()
            .setIcon("stock_ticker_update")
            .setColor("#f45342")
            .build())
        .build())
    .setApnsConfig(ApnsConfig.builder()
        .setAps(Aps.builder()
            .setBadge(42)
            .build())
        .build())
    .setTopic("industry-tech")
    .build();
FirebaseMessagingSnippets.java

پایتون

message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    android=messaging.AndroidConfig(
        ttl=datetime.timedelta(seconds=3600),
        priority='normal',
        notification=messaging.AndroidNotification(
            icon='stock_ticker_update',
            color='#f45342'
        ),
    ),
    apns=messaging.APNSConfig(
        payload=messaging.APNSPayload(
            aps=messaging.Aps(badge=42),
        ),
    ),
    topic='industry-tech',
)
cloud_messaging.py

برو

oneHour := time.Duration(1) * time.Hour
badge := 42
message := &messaging.Message{
	Notification: &messaging.Notification{
		Title: "$GOOG up 1.43% on the day",
		Body:  "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
	},
	Android: &messaging.AndroidConfig{
		TTL: &oneHour,
		Notification: &messaging.AndroidNotification{
			Icon:  "stock_ticker_update",
			Color: "#f45342",
		},
	},
	APNS: &messaging.APNSConfig{
		Payload: &messaging.APNSPayload{
			Aps: &messaging.Aps{
				Badge: &badge,
			},
		},
	},
	Topic: "industry-tech",
}
messaging.go

سی شارپ

var message = new Message
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Android = new AndroidConfig()
    {
        TimeToLive = TimeSpan.FromHours(1),
        Notification = new AndroidNotification()
        {
            Icon = "stock_ticker_update",
            Color = "#f45342",
        },
    },
    Apns = new ApnsConfig()
    {
        Aps = new Aps()
        {
            Badge = 42,
        },
    },
    Topic = "industry-tech",
};
FirebaseMessagingSnippets.cs

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"`$FooCorp` up 1.43% on the day",
       "body":"FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day."
     },
     "android":{
       "notification":{
         "icon":"stock_ticker_update",
         "color":"#7e55c3"
       }
     }
   }
 }

برای جزئیات کامل کلیدهای موجود در بلوک‌های مخصوص پلتفرم در متن پیام، به مستندات مرجع HTTP v1 مراجعه کنید.

مثال: پیام اعلان با یک تصویر سفارشی

مثال زیر درخواست ارسال یک عنوان اعلان مشترک را به همه پلتفرم ها ارسال می کند، اما یک تصویر نیز ارسال می کند. در اینجا تقریبی از جلوه بصری روی دستگاه کاربر آورده شده است:

Node.js

const topicName = 'industry-tech';

const message = {
  notification: {
    title: 'Sparky says hello!'
  },
  android: {
    notification: {
      imageUrl: 'https://foo.bar.pizza-monster.png'
    }
  },
  apns: {
    payload: {
      aps: {
        'mutable-content': 1
      }
    },
    fcm_options: {
      image: 'https://foo.bar.pizza-monster.png'
    }
  },
  webpush: {
    headers: {
      image: 'https://foo.bar.pizza-monster.png'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"Sparky says hello!",
     },
     "android":{
       "notification":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "mutable-content":1
         }
       },
       "fcm_options": {
           "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "webpush":{
       "headers":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     }
   }
 }

برای جزئیات کامل کلیدهای موجود در بلوک‌های مخصوص پلتفرم در متن پیام، به مستندات مرجع HTTP v1 مراجعه کنید.

مثال: پیام اعلان با یک اقدام کلیک مرتبط

مثال زیر درخواست ارسال یک عنوان اعلان مشترک را به همه پلتفرم‌ها ارسال می‌کند، اما همچنین اقدامی را برای برنامه ارسال می‌کند تا در پاسخ به تعامل کاربر با اعلان انجام دهد. در اینجا تقریبی از جلوه بصری روی دستگاه کاربر آورده شده است:

Node.js

const topicName = 'industry-tech';

const message = {
  notification: {
    title: 'Breaking News....'
  },
  android: {
    notification: {
      clickAction: 'news_intent'
    }
  },
  apns: {
    payload: {
      aps: {
        'category': 'INVITE_CATEGORY'
      }
    }
  },
  webpush: {
    fcmOptions: {
      link: 'breakingnews.html'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"Breaking News...",
     },
     "android":{
       "notification":{
         "click_action":"news_intent"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "category" : "INVITE_CATEGORY"
         }
       },
     },
     "webpush":{
       "fcm_options":{
         "link":"breakingnews.html"
       }
     }
   }
 }

برای جزئیات کامل کلیدهای موجود در بلوک‌های مخصوص پلتفرم در متن پیام، به مستندات مرجع HTTP v1 مراجعه کنید.

مثال: پیام اعلان با گزینه های محلی سازی

مثال زیر درخواست ارسال گزینه‌های محلی‌سازی را برای مشتری ارسال می‌کند تا پیام‌های محلی را نمایش دهد. در اینجا تقریبی از جلوه بصری روی دستگاه کاربر آورده شده است:

Node.js

var topicName = 'industry-tech';

var message = {
  android: {
    ttl: 3600000,
    notification: {
      bodyLocKey: 'STOCK_NOTIFICATION_BODY',
      bodyLocArgs: ['FooCorp', '11.80', '835.67', '1.43']
    }
  },
  apns: {
    payload: {
      aps: {
        alert: {
          locKey: 'STOCK_NOTIFICATION_BODY',
          locArgs: ['FooCorp', '11.80', '835.67', '1.43']
        }
      }
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
             "topic":"Tech",
             "android":{
               "ttl":"3600s",
               "notification":{
                 "body_loc_key": "STOCK_NOTIFICATION_BODY",
                 "body_loc_args":  ["FooCorp", "11.80", "835.67", "1.43"],
               },
             },
             "apns":{
               "payload":{
                 "aps":{
                   "alert" : {
                     "loc-key": "STOCK_NOTIFICATION_BODY",
                     "loc-args":  ["FooCorp", "11.80", "835.67", "1.43"],
                    },
                 },
               },
             },
  },
}'

برای جزئیات کامل کلیدهای موجود در بلوک‌های مخصوص پلتفرم در متن پیام، به مستندات مرجع HTTP v1 مراجعه کنید.

کدهای خطا REST برای HTTP v1 API

پاسخ های خطای HTTP برای HTTP v1 API حاوی کد خطا، پیام خطا و وضعیت خطا است. آنها همچنین ممکن است حاوی یک آرایه details با جزئیات بیشتر در مورد خطا باشند.

در اینجا دو نمونه پاسخ خطا آورده شده است:

مثال 1: پاسخ خطا از درخواست HTTP v1 API با مقدار نامعتبر در پیام داده

{
  "error": {
    "code": 400,
    "message": "Invalid value at 'message.data[0].value' (TYPE_STRING), 12",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.BadRequest",
        "fieldViolations": [
          {
            "field": "message.data[0].value",
            "description": "Invalid value at 'message.data[0].value' (TYPE_STRING), 12"
          }
        ]
      }
    ]
  }
}

مثال 2: پاسخ خطا از یک درخواست API HTTP v1 با یک نشانه ثبت نام معتبر

{
  "error": {
    "code": 400,
    "message": "The registration token is not a valid FCM registration token",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.firebase.fcm.v1.FcmError",
        "errorCode": "INVALID_ARGUMENT"
      }
    ]
   }
}

توجه داشته باشید که هر دو پیام کد و وضعیت یکسانی دارند، اما آرایه جزئیات حاوی مقادیر در انواع مختلف است. نمونه اول دارای نوع type.googleapis.com/google.rpc.BadRequest است که نشان دهنده خطا در مقادیر درخواست است. مثال دوم با نوع type.googleapis.com/google.firebase.fcm.v1.FcmError دارای یک خطای خاص FCM است. برای بسیاری از خطاها، آرایه جزئیات حاوی اطلاعاتی است که برای اشکال زدایی و یافتن وضوح نیاز دارید.

جدول زیر کدهای خطای FCM v1 REST API و توضیحات آنها را فهرست می کند.

کد خطا	مراحل شرح و تفکیک
UNSPECIFIED_ERROR اطلاعات بیشتری در مورد این خطا در دسترس نیست.	هیچ کدام.
INVALID_ARGUMENT (کد خطای HTTP = 400) پارامترهای درخواست نامعتبر بودند. پسوندی از نوع google.rpc.BadRequest برگردانده می شود تا مشخص شود کدام فیلد نامعتبر است.	دلایل بالقوه شامل ثبت نامعتبر، نام بسته نامعتبر، پیام خیلی بزرگ، کلید داده نامعتبر، TTL نامعتبر، یا سایر پارامترهای نامعتبر است. ثبت نام نامعتبر : فرمت رمز ثبت نامی که به سرور ارسال می کنید را بررسی کنید. مطمئن شوید که با نشانه ثبتی که برنامه مشتری از ثبت نام در FCM دریافت می کند مطابقت دارد. نشانه را کوتاه نکنید یا کاراکترهای اضافی اضافه نکنید. نام بسته نامعتبر : مطمئن شوید که پیام به نشانه ثبتی که نام بسته آن با مقدار ارسال شده در درخواست مطابقت دارد، خطاب شده است. پیام خیلی بزرگ : بررسی کنید که حجم کل داده‌های محموله موجود در یک پیام از محدودیت‌های FCM تجاوز نکند: 4096 بایت برای بیشتر پیام‌ها، یا 2048 بایت در مورد پیام‌ها به موضوعات. این شامل کلیدها و مقادیر می شود. کلید داده نامعتبر : بررسی کنید که داده‌های محموله حاوی کلید (مانند از، یا gcm، یا هر مقداری که پیشوند Google است) نباشد که به صورت داخلی توسط FCM استفاده می‌شود. توجه داشته باشید که برخی از کلمات (مانند collapse_key) توسط FCM نیز استفاده می شوند اما در payload مجاز هستند، در این صورت مقدار payload با مقدار FCM لغو می شود. TTL نامعتبر : بررسی کنید که مقدار استفاده شده در ttl یک عدد صحیح باشد که مدت زمان بر حسب ثانیه را بین 0 تا 2,419,200 (4 هفته) نشان می دهد. پارامترهای نامعتبر : بررسی کنید که پارامترهای ارائه شده نام و نوع مناسبی داشته باشند.
UNREGISTERED (کد خطای HTTP = 404) نمونه برنامه از FCM ثبت نشده است. این معمولاً به این معنی است که توکن مورد استفاده دیگر معتبر نیست و باید از یک توکن جدید استفاده شود.	این خطا می تواند ناشی از گم شدن توکن های ثبت نام یا توکن های ثبت نشده باشد. عدم ثبت نام : اگر هدف پیام یک مقدار token است، بررسی کنید که درخواست حاوی نشانه ثبت باشد. ثبت نشده : یک رمز ثبت موجود ممکن است در تعدادی از سناریوها از بین برود، از جمله: - اگر برنامه مشتری با FCM لغو ثبت نام کند. - اگر برنامه مشتری به طور خودکار ثبت نشده باشد، در صورتی که کاربر برنامه را حذف نصب کند، ممکن است اتفاق بیفتد. به عنوان مثال، در iOS، اگر سرویس بازخورد APNs توکن APN را نامعتبر گزارش کند. - اگر رمز ثبت نام منقضی شود (برای مثال، ممکن است Google تصمیم بگیرد که نشانه های ثبت نام را به روز کند، یا نشانه APNs برای دستگاه های iOS منقضی شده است). - اگر برنامه سرویس گیرنده به روز شده است اما نسخه جدید برای دریافت پیام پیکربندی نشده است. برای همه این موارد، این رمز ثبت نام را از سرور برنامه حذف کنید و استفاده از آن برای ارسال پیام را متوقف کنید.
SENDER_ID_MISMATCH (کد خطای HTTP = 403) شناسه فرستنده احراز هویت شده با شناسه فرستنده رمز ثبت نام متفاوت است.	یک نشانه ثبت نام به گروه خاصی از فرستندگان گره خورده است. هنگامی که یک برنامه مشتری برای FCM ثبت نام می کند، باید مشخص کند که کدام فرستنده مجاز به ارسال پیام است. هنگام ارسال پیام به برنامه مشتری باید از یکی از آن شناسه های فرستنده استفاده کنید. اگر به فرستنده دیگری بروید، نشانه‌های ثبت‌نام موجود کار نمی‌کنند.
QUOTA_EXCEEDED (کد خطای HTTP = 429) از محدودیت ارسال برای هدف پیام فراتر رفت. پسوندی از نوع google.rpc.QuotaFailure برگردانده می شود تا مشخص شود از کدام سهمیه فراتر رفته است.	این خطا می تواند ناشی از فراتر رفتن از سهمیه نرخ پیام، فراتر از سهمیه نرخ پیام دستگاه، یا فراتر از سهمیه نرخ پیام موضوعی باشد. نرخ پیام بیش از حد : نرخ ارسال پیام ها بسیار بالا است. شما باید نرخ کلی ارسال پیام را کاهش دهید. از عقب نشینی نمایی با حداقل تاخیر اولیه 1 دقیقه برای امتحان مجدد پیام های رد شده استفاده کنید. نرخ پیام دستگاه بیش از حد است : نرخ پیام‌ها به یک دستگاه خاص بسیار زیاد است. محدودیت نرخ پیام برای یک دستگاه را ببینید . تعداد پیام‌های ارسال شده به این دستگاه را کاهش دهید و برای ارسال مجدد از عقب‌نشینی نمایی استفاده کنید. نرخ پیام موضوع بیش از حد است : نرخ پیام به مشترکین یک موضوع خاص بسیار زیاد است. تعداد پیام‌های ارسال‌شده برای این موضوع را کاهش دهید و برای ارسال مجدد از عقب‌نشینی نمایی با حداقل تأخیر اولیه ۱ دقیقه استفاده کنید.
UNAVAILABLE (کد خطای HTTP = 503) سرور بیش از حد بارگیری شده است.	سرور نتوانست به موقع درخواست را پردازش کند. همان درخواست را دوباره امتحان کنید، اما باید: - اگر هدر Retry-After در پاسخ سرور اتصال FCM گنجانده شده است، به آن احترام بگذارید. - در مکانیسم تلاش مجدد خود، عقب نشینی نمایی را پیاده سازی کنید. (مثلاً اگر یک ثانیه قبل از اولین تلاش مجدد صبر کرده اید، حداقل دو ثانیه قبل از امتحان بعدی صبر کنید، سپس 4 ثانیه و غیره). اگر چندین پیام ارسال می‌کنید، از جیترینگ استفاده کنید. برای کسب اطلاعات بیشتر، به مدیریت تلاش های مجدد مراجعه کنید . فرستنده هایی که مشکل ایجاد می کنند در معرض خطر رد شدن هستند.
INTERNAL (کد خطای HTTP = 500) یک خطای داخلی ناشناخته رخ داد.	سرور هنگام تلاش برای پردازش درخواست با خطایی مواجه شد. می‌توانید همان درخواست را پس از پیشنهادات موجود در «کنترل تلاش‌های مجدد» دوباره امتحان کنید . اگر خطا ادامه داشت، لطفاً با پشتیبانی Firebase تماس بگیرید.
THIRD_PARTY_AUTH_ERROR (کد خطای HTTP = 401) گواهینامه APN یا کلید تأیید وب فشار نامعتبر یا گم شده بود.	پیامی که برای یک دستگاه iOS یا ثبت وب پوش هدف گذاری شده است ارسال نشد. اعتبار اعتبارنامه توسعه و تولید خود را بررسی کنید.

کدهای خطای ادمین

جدول زیر کدهای خطای Firebase Admin FCM API و توضیحات آنها، از جمله مراحل وضوح پیشنهادی را فهرست می‌کند.

کد خطا	مراحل شرح و تفکیک
messaging/invalid-argument	یک آرگومان نامعتبر به روش FCM ارائه شد. پیام خطا باید حاوی اطلاعات اضافی باشد.
messaging/invalid-recipient	گیرنده پیام مورد نظر نامعتبر است. پیام خطا باید حاوی اطلاعات اضافی باشد.
messaging/invalid-payload	یک شیء محموله پیام نامعتبر ارائه شد. پیام خطا باید حاوی اطلاعات اضافی باشد.
messaging/invalid-data-payload-key	محموله پیام داده حاوی یک کلید نامعتبر است. به مستندات مرجع DataMessagePayload برای کلیدهای محدود مراجعه کنید.
messaging/payload-size-limit-exceeded	محموله پیام ارائه شده از محدودیت های اندازه FCM بیشتر است. محدودیت برای اکثر پیام ها 4096 بایت است. برای پیام های ارسال شده به موضوعات، محدودیت 2048 بایت است. اندازه کل محموله شامل کلیدها و مقادیر است.
messaging/invalid-options	یک شیء گزینه های پیام نامعتبر ارائه شد. پیام خطا باید حاوی اطلاعات اضافی باشد.
messaging/invalid-registration-token	رمز ثبت نام معتبر ارائه شده است. مطمئن شوید که با نشانه ثبتی که برنامه مشتری از ثبت نام در FCM دریافت می کند مطابقت دارد. از کوتاه کردن یا اضافه کردن کاراکترهای اضافی به آن خودداری کنید.
messaging/registration-token-not-registered	رمز ثبت نام ارائه شده ثبت نشده است. نشانه ثبت نام معتبر قبلی به دلایل مختلفی می تواند لغو ثبت شود، از جمله: برنامه مشتری خود را از FCM لغو ثبت کرد. برنامه مشتری به طور خودکار لغو ثبت شد. اگر کاربر برنامه را حذف نصب کند یا در پلتفرم‌های اپل، اگر سرویس بازخورد APNs توکن APN را نامعتبر گزارش کرده باشد، ممکن است این اتفاق بیفتد. ژتون ثبت نام منقضی شده است. برای مثال، ممکن است Google تصمیم بگیرد که نشانه‌های ثبت نام را به‌روزرسانی کند یا نشانه‌های APN ممکن است برای دستگاه‌های اپل منقضی شده باشد. برنامه مشتری به روز شد، اما نسخه جدید برای دریافت پیام پیکربندی نشده است. برای همه این موارد، این رمز ثبت نام را حذف کنید و استفاده از آن برای ارسال پیام را متوقف کنید.
messaging/invalid-package-name	این پیام به نشانه ثبت نامی که نام بسته آن با گزینه restrictedPackageName ارائه شده مطابقت ندارد، خطاب شده است.
messaging/message-rate-exceeded	نرخ پیام به یک هدف خاص بسیار بالا است. تعداد پیام های ارسال شده به این دستگاه یا موضوع را کاهش دهید و فوراً ارسال مجدد به این هدف را تکرار نکنید.
messaging/device-message-rate-exceeded	نرخ پیام به یک دستگاه خاص بسیار بالا است. تعداد پیام های ارسال شده به این دستگاه را کاهش دهید و فوراً ارسال مجدد به این دستگاه را تکرار نکنید.
messaging/topics-message-rate-exceeded	نرخ پیام به مشترکین یک موضوع خاص بسیار زیاد است. تعداد پیام های ارسال شده برای این موضوع را کاهش دهید و بلافاصله ارسال مجدد به این موضوع را تکرار نکنید.
messaging/too-many-topics	یک نشانه ثبت نام در حداکثر تعداد موضوع مشترک شده است و دیگر نمی توان در آن مشترک شد.
messaging/invalid-apns-credentials	پیامی که برای دستگاه Apple مورد هدف قرار گرفته است ارسال نشد زیرا گواهینامه SSL APN های مورد نیاز آپلود نشده یا منقضی شده است. اعتبار گواهی های توسعه و تولید خود را بررسی کنید.
messaging/mismatched-credential	اعتبار مورد استفاده برای احراز هویت این SDK مجوز ارسال پیام به دستگاه مربوط به رمز ثبت نام ارائه شده را ندارد. اطمینان حاصل کنید که اعتبار و رمز ثبت نام هر دو متعلق به یک پروژه Firebase هستند. برای مستندات مربوط به نحوه احراز هویت Firebase Admin SDK s ، به افزودن Firebase به برنامه خود مراجعه کنید.
messaging/authentication-error	SDK نمی تواند در سرورهای FCM احراز هویت شود. اطمینان حاصل کنید که Firebase Admin SDK با اعتباری که دارای مجوزهای مناسب برای ارسال پیام‌های FCM است، احراز هویت کنید. برای مستندات مربوط به نحوه احراز هویت Firebase Admin SDK s ، به افزودن Firebase به برنامه خود مراجعه کنید.
messaging/server-unavailable	سرور FCM نتوانست به موقع درخواست را پردازش کند. شما باید همان درخواست را دوباره امتحان کنید، اما باید: اگر سرصفحه Retry-After در پاسخ سرور اتصال FCM گنجانده شده است، به آن احترام بگذارید. در مکانیسم تلاش مجدد خود، عقب نشینی نمایی را اجرا کنید. به عنوان مثال، اگر قبل از اولین تلاش مجدد یک ثانیه صبر کرده اید، حداقل دو ثانیه قبل از امتحان بعدی، سپس چهار ثانیه و غیره صبر کنید. اگر چندین پیام ارسال می کنید، هر کدام را به طور مستقل با مقدار تصادفی اضافی به تاخیر بیندازید تا از صدور درخواست جدید برای همه پیام ها به طور همزمان جلوگیری کنید. فرستنده هایی که مشکل ایجاد می کنند در معرض خطر قرار گرفتن در لیست سیاه هستند.
messaging/internal-error	سرور FCM هنگام تلاش برای پردازش درخواست با خطا مواجه شد. می‌توانید با پیروی از الزامات فهرست‌شده در ردیف messaging/server-unavailable در بالا، همان درخواست را دوباره امتحان کنید. اگر خطا ادامه داشت، لطفاً مشکل را به کانال پشتیبانی گزارش اشکال ما گزارش دهید.
messaging/unknown-error	یک خطای سرور ناشناخته برگردانده شد. برای جزئیات بیشتر پاسخ سرور خام را در پیام خطا مشاهده کنید. اگر این خطا را دریافت کردید، لطفاً پیام خطای کامل را به کانال پشتیبانی گزارش اشکال گزارش دهید.

با استفاده از پروتکل‌های سرور برنامه قدیمی پیام‌ها را ارسال کنید

احتیاط: ارسال پیام‌ها (از جمله پیام‌های بالادست) با APIهای قدیمی FCM XMPP و HTTP در 20 ژوئن 2023 منسوخ شد و از ژوئن 2024 حذف خواهد شد . اگر از APIهای ارسال FCM قدیمی استفاده می‌کنید، اکیداً توصیه می‌کنیم به API HTTP v1 مهاجرت کنید یا از Admin SDK برای ایجاد درخواست‌های ارسال استفاده کنید.

اگر در حال حاضر از پروتکل های قدیمی استفاده می کنید، درخواست های پیام را همانطور که در این بخش نشان داده شده است ایجاد کنید. به خاطر داشته باشید که اگر از طریق HTTP به چندین پلتفرم ارسال می کنید، پروتکل v1 می تواند درخواست های پیام شما را تا حد زیادی ساده کند.

ارسال پیام به دستگاه های خاص

برای ارسال پیام به دستگاه‌های خاص، کلید to را روی نشانه ثبت‌نام برای نمونه برنامه خاص تنظیم کنید. برای کسب اطلاعات بیشتر در مورد نشانه های ثبت نام، اطلاعات راه اندازی مشتری برای پلتفرم خود را ببینید.

درخواست HTTP POST

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}

پاسخ HTTP

{ "multicast_id": 108,
  "success": 1,
  "failure": 0,
  "results": [
    { "message_id": "1:08" }
  ]
}

پیام XMPP

<message id="">
  <gcm xmlns="google:mobile:data">
    { "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  }
  </gcm>
</message>

پاسخ XMPP

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "from":"REGID",
      "message_id":"m-1366082849205"
      "message_type":"ack"
  }
  </gcm>
</message>

سرور اتصال XMPP گزینه های دیگری را برای پاسخ ها فراهم می کند. فرمت پاسخ سرور را ببینید.

برای فهرست کامل گزینه‌های پیام موجود هنگام ارسال پیام‌های پایین‌دستی به برنامه‌های مشتری، به اطلاعات مرجع پروتکل سرور اتصال انتخابی خود، HTTP یا XMPP مراجعه کنید.

ارسال پیام به موضوعات

ارسال پیام به یک موضوع Firebase Cloud Messaging بسیار شبیه به ارسال پیام به یک دستگاه یا یک گروه کاربری است. سرور برنامه to را با مقداری مانند /topics/yourTopic تنظیم می کند. برنامه‌نویسان می‌توانند هر نام موضوعی را که با عبارت معمولی مطابقت دارد انتخاب کنند: "/topics/[a-zA-Z0-9-_.~%]+" .

برای ارسال به ترکیبی از چندین موضوع، سرور برنامه باید کلید condition (به جای کلید to ) را روی یک شرط بولی تنظیم کند که موضوعات مورد نظر را مشخص می کند. به عنوان مثال، برای ارسال پیام به دستگاه‌هایی که مشترک TopicA و TopicB یا TopicC هستند:

'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)

FCM ابتدا هر شرایط داخل پرانتز را ارزیابی می کند و سپس عبارت را از چپ به راست ارزیابی می کند. در عبارت بالا، کاربری که در یک موضوع مشترک است، پیامی را دریافت نمی کند. به همین ترتیب، کاربری که در TopicA مشترک نمی شود، پیام را دریافت نمی کند. این ترکیب ها آن را دریافت می کنند:

• TopicA و TopicB
• موضوع A و موضوع C

می توانید حداکثر پنج موضوع را در عبارت شرطی خود بگنجانید و پرانتزها پشتیبانی می شوند. اپراتورهای پشتیبانی شده: && ، || .

موضوع درخواست HTTP POST

ارسال به یک موضوع:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

ارسال به دستگاه‌هایی که در موضوعات «سگ» یا «گربه» مشترک شده‌اند:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

پاسخ HTTP موضوع

// Success example:
{
  "message_id": "1023456"
}

// failure example:
{
  "error": "TopicsMessageRateExceeded"
}

موضوع پیام XMPP

ارسال به یک موضوع:

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

ارسال به دستگاه‌هایی که در موضوعات «سگ» یا «گربه» مشترک شده‌اند:

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

پاسخ موضوع XMPP

// Success example:
{
  "message_id": "1023456"
}

// failure example:
{
  "error": "TopicsMessageRateExceeded"
}

قبل از اینکه سرور FCM یک پاسخ موفقیت آمیز یا ناموفق را به درخواست های ارسال موضوع ارسال کند، تا 30 ثانیه تاخیر انتظار داشته باشید. مطمئن شوید که مقدار مهلت زمانی سرور برنامه را در درخواست تنظیم کنید.

توجه: همچنین می توان با تنظیم کلید condition ، پیام ها را به چندین موضوع هدف قرار داد. برای اطلاعات بیشتر، راهنمای پیام‌رسانی موضوع پلتفرم خود را ببینید.

ارسال پیام به گروه های دستگاه

احتیاط: ارسال پیام‌ها (از جمله پیام‌های بالادست) با APIهای قدیمی FCM XMPP و HTTP در 20 ژوئن 2023 منسوخ شد و از ژوئن 2024 حذف خواهد شد . اگر از APIهای ارسال FCM قدیمی استفاده می‌کنید، اکیداً توصیه می‌کنیم به API HTTP v1 مهاجرت کنید یا از Admin SDK برای ایجاد درخواست‌های ارسال استفاده کنید.

ارسال پیام به یک گروه دستگاه با استفاده از APIهای قدیمی قدیمی بسیار شبیه به ارسال پیام به یک دستگاه جداگانه است. پارامتر to را روی کلید اعلان یکتا برای گروه دستگاه تنظیم کنید. مثال‌های این بخش نحوه ارسال پیام‌های داده به گروه‌های دستگاه در پروتکل‌های قدیمی HTTP و XMPP را نشان می‌دهد.

درخواست HTTP POST گروه دستگاه

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{
  "to": "aUniqueKey",
  "data": {
    "hello": "This is a Firebase Cloud Messaging Device Group Message!",
   }
}

پاسخ HTTP گروه دستگاه

در اینجا یک مثال از "موفقیت" آمده است - notification_key دارای 2 نشانه ثبت نام مرتبط با آن است و پیام با موفقیت برای هر دوی آنها ارسال شد:

{
  "success": 2,
  "failure": 0
}

در اینجا یک مثال از "موفقیت جزئی" آمده است - notification_key دارای 3 نشانه ثبت نام مرتبط با آن است. پیام فقط به یکی از نشانه های ثبت نام با موفقیت ارسال شد. پیام پاسخ، نشانه‌های ثبت نام ( registration_ids ) را که موفق به دریافت پیام نشده‌اند، فهرست می‌کند:

{
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

هنگامی که پیامی به یک یا چند نشانه ثبت نام مرتبط با یک notification_key تحویل داده نمی‌شود، سرور برنامه باید با پشتیبان بین تلاش‌های مجدد، مجدداً تلاش کند.

اگر سرور بخواهد پیامی را به گروه دستگاهی که هیچ عضوی ندارد ارسال کند، پاسخ به شکل زیر است، با 0 موفقیت و 0 شکست:

{
  "success": 0,
  "failure": 0
}

پیام XMPP گروه دستگاه

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "to": "aUniqueKey",
      "message_id": "m-1366082849205" ,
      "data": {
          "hello":"This is a Firebase Cloud Messaging Device Group Message!"
      }
  }
  </gcm>
</message>

پاسخ XMPP گروه دستگاه

هنگامی که پیام با موفقیت به یکی از دستگاه های گروه ارسال می شود، سرور اتصال XMPP با یک ACK پاسخ می دهد. اگر همه پیام‌های ارسال شده به همه دستگاه‌های گروه ناموفق باشند، سرور اتصال XMPP با NACK پاسخ می‌دهد.

در اینجا یک مثال از "موفقیت" آمده است - notification_key دارای 3 نشانه ثبت نام مرتبط با آن است و پیام با موفقیت برای همه آنها ارسال شد:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success": 3,
  "failure": 0,
  "message_id": "m-1366082849205"
}

در اینجا یک مثال از "موفقیت جزئی" آمده است - notification_key دارای 3 نشانه ثبت نام مرتبط با آن است. پیام فقط به یکی از نشانه های ثبت نام با موفقیت ارسال شد. پیام پاسخ، نشانه های ثبت نامی را که پیام را دریافت نکرده اند فهرست می کند:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

وقتی سرور اتصال FCM نتواند به همه دستگاه‌های گروه تحویل دهد. سرور برنامه یک پاسخ ناک دریافت خواهد کرد.

برای لیست کامل گزینه های پیام، اطلاعات مرجع پروتکل سرور اتصال انتخابی خود، HTTP یا XMPP را ببینید.

روش‌های ارسال قدیمی Firebase Admin SDK

احتیاط: APIهای Node.js Admin SDK توضیح داده شده در این بخش در 21 فوریه 2023 منسوخ شدند و عملکرد در فوریه 2024 حذف خواهد شد. به جای sendToDevice() و sendToDeviceGroup() از send() استفاده کنید.

Firebase Admin Node.js SDK از روش هایی برای ارسال پیام ( FCM ) بر اساس API سرور FCM Legacy پشتیبانی می کند. این متدها آرگومان های متفاوتی را در مقایسه با متد send() می پذیرند. شما باید در صورت امکان از متد send() استفاده کنید و فقط هنگام ارسال پیام به دستگاه‌ها یا گروه‌های دستگاه از روش‌های توضیح داده شده در این صفحه استفاده کنید.

توجه: این APIها فقط در Admin Node.js SDK موجود هستند.

ارسال به دستگاه های فردی

می توانید یک رمز ثبت نام را به متد sendToDevice() برای ارسال پیام به آن دستگاه ارسال کنید:

Node.js

// This registration token comes from the client FCM SDKs.
const registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device corresponding to the provided
// registration token.
getMessaging().sendToDevice(registrationToken, payload)
  .then((response) => {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

متد sendToDevice() همچنین می‌تواند یک پیام چندپخشی (یعنی یک پیام به چندین دستگاه) را با ارسال یک آرایه از نشانه‌های ثبت به جای تنها یک نشانه ثبت ارسال کند:

Node.js

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...',
  // ...
  'ecupwIfBy1w:APA91bFtuMY7MktgxA3Au_Qx7cKqnf...'
];

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the devices corresponding to the provided
// registration tokens.
getMessaging().sendToDevice(registrationTokens, payload)
  .then((response) => {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

توجه: شما می توانید در یک درخواست به حداکثر 1000 دستگاه پیام ارسال کنید. اگر آرایه ای با بیش از 1000 نشانه ثبت ارائه کنید، درخواست با خطای messaging/invalid-recipient شکست می خورد.

متد sendToDevice() وعده ای را برمی گرداند که با یک شی MessagingDevicesResponse حاوی پاسخ FCM حل می شود. نوع برگشتی در هنگام ارسال یک نشانه ثبت نام واحد یا آرایه ای از نشانه های ثبت، فرمت یکسانی دارد.

برخی از موارد مانند خطای احراز هویت یا محدود کردن نرخ باعث می شود که کل پیام پردازش نشود. در این موارد، وعده بازگشتی توسط sendToDevice() با خطا رد می شود. برای فهرست کامل کدهای خطا، از جمله توضیحات و مراحل حل، به Admin FCM API Errors مراجعه کنید.

ارسال به گروه دستگاه

متد sendToDeviceGroup() به شما این امکان را می دهد که با تعیین کلید اعلان برای آن گروه دستگاه پیامی را به گروه دستگاه ارسال کنید:

Node.js

// See the "Managing device groups" link above on how to generate a
// notification key.
const notificationKey = 'some-notification-key';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device group corresponding to the provided
// notification key.
getMessaging().sendToDeviceGroup(notificationKey, payload)
  .then((response) => {
    // See the MessagingDeviceGroupResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

متد sendToDeviceGroup() وعده ای را برمی گرداند که با یک شی MessagingDevicesResponse حاوی پاسخ FCM حل می شود.

برخی از موارد مانند خطای احراز هویت یا محدود کردن نرخ باعث می شود که کل پیام پردازش نشود. در این موارد، وعده بازگشتی توسط sendToDeviceGroup() با خطا رد می شود. برای فهرست کامل کدهای خطا، از جمله توضیحات و مراحل حل، به Admin FCM API Errors مراجعه کنید.

تعریف محموله پیام

روش های فوق بر اساس پروتکل های قدیمی FCM یک بار پیام را به عنوان آرگومان دوم خود می پذیرند و از پیام های اطلاع رسانی و داده پشتیبانی می کنند. شما می توانید یک یا هر دو نوع پیام را با ایجاد یک شی با کلیدهای data و/یا notification مشخص کنید. به عنوان مثال، در اینجا نحوه تعریف انواع مختلف بارهای پیام آورده شده است:

پیام اعلان

const payload = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  }
};

پیام داده

const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

پیام ترکیبی

const payload = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  data: {
    stock: 'GOOG',
    open: '829.62',
    close: '635.67'
  }
};

محموله‌های پیام اعلان دارای زیرمجموعه‌ای از ویژگی‌های معتبر از پیش تعریف‌شده هستند و بسته به اینکه کدام سیستم عامل موبایلی را هدف قرار می‌دهید، کمی متفاوت است. برای فهرست کامل به اسناد مرجع برای NotificationMessagePayload مراجعه کنید.

بارهای پیام داده از جفت های کلید-مقدار سفارشی با چند محدودیت تشکیل شده اند، از جمله این واقعیت که همه مقادیر باید رشته ای باشند. برای مشاهده لیست کامل محدودیت ها به اسناد مرجع DataMessagePayload مراجعه کنید.

تعریف گزینه های پیام

روش‌های فوق مبتنی بر پروتکل‌های قدیمی FCM ، آرگومان سوم اختیاری را می‌پذیرند که برخی از گزینه‌ها را برای پیام مشخص می‌کند. به عنوان مثال، مثال زیر یک پیام با اولویت بالا به دستگاهی ارسال می کند که پس از 24 ساعت منقضی می شود:

Node.js

// This registration token comes from the client FCM SDKs.
const registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section above for details
// on how to define a message payload.
const payload = {
  notification: {
    title: 'Urgent action needed!',
    body: 'Urgent action is needed to prevent your account from being disabled!'
  }
};

// Set the message as high priority and have it expire after 24 hours.
const options = {
  priority: 'high',
  timeToLive: 60 * 60 * 24
};

// Send a message to the device corresponding to the provided
// registration token with the provided options.
getMessaging().sendToDevice(registrationToken, payload, options)
  .then((response) => {
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

برای لیست کامل گزینه های موجود، به اسناد مرجع برای MessagingOptions مراجعه کنید.

،

با استفاده از Firebase Admin SDK یا پروتکل‌های سرور برنامه FCM ، می‌توانید درخواست‌های پیام بسازید و آنها را به این نوع اهداف ارسال کنید:

• نام موضوع
• وضعیت
• رمز ثبت دستگاه
• نام گروه دستگاه (فقط پروتکل)

می‌توانید پیام‌هایی را با یک محموله اعلان متشکل از فیلدهای از پیش تعریف‌شده، یک محموله داده از فیلدهای تعریف‌شده توسط کاربر یا پیامی حاوی هر دو نوع بار ارسال کنید. برای اطلاعات بیشتر به انواع پیام مراجعه کنید.

مهم: درخواست‌های ارسال برای Firebase Admin SDK و v1 HTTP باید حاوی شناسه پروژه پروژه Firebase برای برنامه شما باشد که در برگه تنظیمات پروژه عمومی کنسول Firebase موجود است. همچنین، برای هر دو روش ارسال پیام، شما باید درخواست‌های ارسال را مجاز کنید .

مثال‌های موجود در این صفحه نحوه ارسال پیام‌های اعلان را با استفاده از Firebase Admin SDK (که از Node ، Java ، Python ، C# و Go پشتیبانی می‌کند) و پروتکل HTTP v1 نشان می‌دهد.

احتیاط: ارسال پیام‌ها (از جمله پیام‌های بالادست) با APIهای قدیمی FCM XMPP و HTTP در 20 ژوئن 2023 منسوخ شد و از ژوئن 2024 حذف خواهد شد . اگر از APIهای ارسال FCM قدیمی استفاده می‌کنید، اکیداً توصیه می‌کنیم به API HTTP v1 مهاجرت کنید یا از Admin SDK برای ایجاد درخواست‌های ارسال استفاده کنید.

ارسال پیام به دستگاه های خاص

برای ارسال به یک دستگاه خاص، رمز ثبت نام دستگاه را مطابق شکل ارسال کنید. برای کسب اطلاعات بیشتر در مورد نشانه های ثبت نام، اطلاعات راه اندازی مشتری برای پلتفرم خود را ببینید.

Node.js

// This registration token comes from the client FCM SDKs.
const registrationToken = 'YOUR_REGISTRATION_TOKEN';

const message = {
  data: {
    score: '850',
    time: '2:45'
  },
  token: registrationToken
};

// Send a message to the device corresponding to the provided
// registration token.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

جاوا

// This registration token comes from the client FCM SDKs.
String registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setToken(registrationToken)
    .build();

// Send a message to the device corresponding to the provided
// registration token.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
FirebaseMessagingSnippets.java

پایتون

# This registration token comes from the client FCM SDKs.
registration_token = 'YOUR_REGISTRATION_TOKEN'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    token=registration_token,
)

# Send a message to the device corresponding to the provided
# registration token.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
cloud_messaging.py

برو

// Obtain a messaging.Client from the App.
ctx := context.Background()
client, err := app.Messaging(ctx)
if err != nil {
	log.Fatalf("error getting Messaging client: %v\n", err)
}

// This registration token comes from the client FCM SDKs.
registrationToken := "YOUR_REGISTRATION_TOKEN"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Token: registrationToken,
}

// Send a message to the device corresponding to the provided
// registration token.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
messaging.go

سی شارپ

// This registration token comes from the client FCM SDKs.
var registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Token = registrationToken,
};

// Send a message to the device corresponding to the provided
// registration token.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
      "notification":{
        "body":"This is an FCM notification message!",
        "title":"FCM Message"
      }
   }
}

دستور cURL:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "notification":{
     "title":"FCM Message",
     "body":"This is an FCM Message"
   },
   "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

در صورت موفقیت، هر روش ارسال یک شناسه پیام را برمی گرداند. Firebase Admin SDK رشته ID را در قالب projects/{project_id}/messages/{message_id} برمی‌گرداند. پاسخ پروتکل HTTP یک کلید JSON است:

    {
      "name":"projects/myproject-b5ae1/messages/0:1500415314455276%31bd1c9631bd1c96"
    }

ارسال پیام به چندین دستگاه

نکته مهم: روشهای ارسال شرح داده شده در این بخش در 21 ژوئن 2023 از بین رفته و در ژوئن 2024 حذف می شود. برای پروتکل ، در عوض از روش استاندارد ارسال HTTP V1 API استفاده کنید ، با استفاده از لیست دریافت کنندگان و ارسال به نشانه گیرنده ، دسته شخصی خود را ارسال کرده و به هر یک از گیرنده ها ارسال کنید. برای روش های SDK Admin ، حتماً نسخه اصلی بعدی را به روز کنید. برای اطلاعات بیشتر به سؤالات متداول Firebase مراجعه کنید.

API های Admin FCM به شما امکان می دهد تا پیامی را به لیستی از نشانه های ثبت نام دستگاه تبدیل کنید. در هر دعوت می توانید حداکثر 500 نشانه ثبت نام دستگاه را مشخص کنید.

Node.js

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
};

getMessaging().sendMulticast(message)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });

جاوا

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");
FirebaseMessagingSnippets.java

پایتون

# Create a list containing up to 500 registration tokens.
# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))
cloud_messaging.py

برو

// Create a list containing up to 500 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)
messaging.go

سی شارپ

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachForMulticastAsync(message);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");
FirebaseMessagingSnippets.cs

مقدار بازگشت لیستی از نشانه هایی است که مطابق با ترتیب نشانه های ورودی است. این زمانی مفید است که می خواهید بررسی کنید که کدام توکن منجر به خطا شده است.

Node.js

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
};

getMessaging().sendMulticast(message)
  .then((response) => {
    if (response.failureCount > 0) {
      const failedTokens = [];
      response.responses.forEach((resp, idx) => {
        if (!resp.success) {
          failedTokens.push(registrationTokens[idx]);
        }
      });
      console.log('List of tokens that caused failures: ' + failedTokens);
    }
  });

جاوا

// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
if (response.getFailureCount() > 0) {
  List<SendResponse> responses = response.getResponses();
  List<String> failedTokens = new ArrayList<>();
  for (int i = 0; i < responses.size(); i++) {
    if (!responses.get(i).isSuccessful()) {
      // The order of responses corresponds to the order of the registration tokens.
      failedTokens.add(registrationTokens.get(i));
    }
  }

  System.out.println("List of tokens that caused failures: " + failedTokens);
}
FirebaseMessagingSnippets.java

پایتون

# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
if response.failure_count > 0:
    responses = response.responses
    failed_tokens = []
    for idx, resp in enumerate(responses):
        if not resp.success:
            # The order of responses corresponds to the order of the registration tokens.
            failed_tokens.append(registration_tokens[idx])
    print('List of tokens that caused failures: {0}'.format(failed_tokens))
cloud_messaging.py

برو

// Create a list containing up to 500 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

if br.FailureCount > 0 {
	var failedTokens []string
	for idx, resp := range br.Responses {
		if !resp.Success {
			// The order of responses corresponds to the order of the registration tokens.
			failedTokens = append(failedTokens, registrationTokens[idx])
		}
	}

	fmt.Printf("List of tokens that caused failures: %v\n", failedTokens)
}
messaging.go

سی شارپ

// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachForMulticastAsync(message);
if (response.FailureCount > 0)
{
    var failedTokens = new List<string>();
    for (var i = 0; i < response.Responses.Count; i++)
    {
        if (!response.Responses[i].IsSuccess)
        {
            // The order of responses corresponds to the order of the registration tokens.
            failedTokens.Add(registrationTokens[i]);
        }
    }

    Console.WriteLine($"List of tokens that caused failures: {failedTokens}");
}
FirebaseMessagingSnippets.cs

ارسال پیام به مباحث

پس از ایجاد یک موضوع ، یا با عضویت در مورد برنامه های مشتری در موضوع در سمت مشتری یا از طریق API سرور ، می توانید پیام هایی را به موضوع ارسال کنید. اگر این اولین بار است که درخواست ارسال درخواست FCM را ارسال می کنید ، برای پیش زمینه و اطلاعات مهم تنظیم ، به راهنمای محیط سرور و FCM خود مراجعه کنید.

در منطق ارسال خود در باطن ، نام موضوع مورد نظر را همانطور که نشان داده شده است مشخص کنید:

Node.js

// The topic name can be optionally prefixed with "/topics/".
const topic = 'highScores';

const message = {
  data: {
    score: '850',
    time: '2:45'
  },
  topic: topic
};

// Send a message to devices subscribed to the provided topic.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

جاوا

// The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setTopic(topic)
    .build();

// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
FirebaseMessagingSnippets.java

پایتون

# The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    topic=topic,
)

# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
cloud_messaging.py

برو

// The topic name can be optionally prefixed with "/topics/".
topic := "highScores"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Topic: topic,
}

// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
messaging.go

سی شارپ

// The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Topic = topic,
};

// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
    "topic" : "foo-bar",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message"
      }
   }
}

دستور curl:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "message": {
    "topic" : "foo-bar",
    "notification": {
      "body": "This is a Firebase Cloud Messaging Topic Message!",
      "title": "FCM Message"
    }
  }
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

برای ارسال پیام به ترکیبی از موضوعات ، یک شرط را مشخص کنید ، که یک عبارت بولی است که موضوعات هدف را مشخص می کند. به عنوان مثال ، شرط زیر پیام هایی را به دستگاه هایی که در TopicA مشترک هستند و یا TopicB یا TopicC ارسال می کنند ، ارسال می کند:

"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"

FCM ابتدا هر شرایطی را در پرانتز ارزیابی می کند ، و سپس عبارت را از چپ به راست ارزیابی می کند. در عبارت فوق ، کاربر مشترک در هر موضوع واحد پیام را دریافت نمی کند. به همین ترتیب ، کاربر که در TopicA مشترک نیست ، پیام را دریافت نمی کند. این ترکیبات آن را دریافت می کنند:

• TopicA و TopicB
• TopicA و TopicC

شما می توانید حداکثر پنج موضوع را در بیان مشروط خود بگنجانید.

برای ارسال به یک شرط:

Node.js

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
const condition = '\'stock-GOOG\' in topics || \'industry-tech\' in topics';

// See documentation on defining a message payload.
const message = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  condition: condition
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

جاوا

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
Message message = Message.builder()
    .setNotification(Notification.builder()
        .setTitle("$GOOG up 1.43% on the day")
        .setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
        .build())
    .setCondition(condition)
    .build();

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
FirebaseMessagingSnippets.java

پایتون

# Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"

# See documentation on defining a message payload.
message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    condition=condition,
)

# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
cloud_messaging.py

برو

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Condition: condition,
}

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
messaging.go

سی شارپ

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
var message = new Message()
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Condition = condition,
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
   "message":{
    "condition": "'dogs' in topics || 'cats' in topics",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message",
    }
  }
}

دستور curl:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "notification": {
    "title": "FCM Message",
    "body": "This is a Firebase Cloud Messaging Topic Message!",
  },
  "condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

ارسال پیام به گروه های دستگاه

برای ارسال پیام به گروه های دستگاه ، از HTTP V1 API استفاده کنید. اگر در حال حاضر با استفاده از API های میراث مستهجن برای HTTP یا XMPP یا هر یک از نسخه های قدیمی تر Firebase Admin SDK برای Node.js بر اساس پروتکل های میراث ، به گروه های دستگاهی ارسال می کنید ، ما اکیداً توصیه می کنیم که در اولین فرصت به HTTP V1 API مهاجرت کنید . API های ارسال میراث در ژوئن سال 2024 غیرفعال و حذف می شوند.

ارسال پیام به یک گروه دستگاه بسیار شبیه به ارسال پیام به یک دستگاه جداگانه است ، با استفاده از همان روش برای اجازه ارسال درخواست ارسال . قسمت token را روی کلید اعلان گروه تنظیم کنید:

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ",
      "data":{
        "hello": "This is a Firebase Cloud Messaging device group message!"
      }
   }
}

فرمان

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "data":{
     "hello": "This is a Firebase Cloud Messaging device group message!"
   },
   "token":"APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ"
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

توجه: بر خلاف روش ارسال گروه دستگاه در API های میراث مستهجن ، پاسخ HTTP V1 شامل موفقیت و عدم موفقیت نیست. ارسال موفق پاسخ خالی را برمی گرداند.

یک دسته از پیام ها ارسال کنید

نکته مهم: روشهای ارسال دسته ای که در این بخش شرح داده شده است در 21 ژوئن 2023 کاهش یافته و در ژوئن سال 2024 حذف می شود. برای پروتکل ، در عوض از روش ارسال استاندارد HTTP V1 API استفاده کنید ، با استفاده از لیست گیرنده ها و ارسال به نشانه گیرنده ها ، ارسال دسته خود را ارسال کرده و به هر یک از گیرنده ها ارسال کنید. برای روش های SDK Admin ، حتماً نسخه اصلی بعدی را به روز کنید. برای اطلاعات بیشتر به سؤالات متداول Firebase مراجعه کنید.

مدیر SDK ها از ارسال پیام در دسته ها پشتیبانی می کنند. شما می توانید حداکثر 500 پیام را به یک دسته واحد گروه بندی کنید و همه آنها را در یک تماس API واحد ارسال کنید ، با بهبود عملکرد قابل توجهی نسبت به ارسال درخواست های HTTP جداگانه برای هر پیام.

این ویژگی می تواند برای ایجاد مجموعه ای از پیام های سفارشی و ارسال آنها به گیرندگان مختلف از جمله موضوعات یا نشانه های ثبت نام دستگاه استفاده شود. از این ویژگی استفاده کنید که به عنوان مثال ، شما باید همزمان پیام ها را برای مخاطبان مختلف با جزئیات کمی متفاوت در بدن پیام ارسال کنید.

Node.js

// Create a list containing up to 500 messages.
const messages = [];
messages.push({
  notification: { title: 'Price drop', body: '5% off all electronics' },
  token: registrationToken,
});
messages.push({
  notification: { title: 'Price drop', body: '2% off all books' },
  topic: 'readers-club',
});

getMessaging().sendAll(messages)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });

جاوا

// Create a list containing up to 500 messages.
List<Message> messages = Arrays.asList(
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("5% off all electronics")
            .build())
        .setToken(registrationToken)
        .build(),
    // ...
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("2% off all books")
            .build())
        .setTopic("readers-club")
        .build()
);

BatchResponse response = FirebaseMessaging.getInstance().sendAll(messages);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");
FirebaseMessagingSnippets.java

پایتون

# Create a list containing up to 500 messages.
messages = [
    messaging.Message(
        notification=messaging.Notification('Price drop', '5% off all electronics'),
        token=registration_token,
    ),
    # ...
    messaging.Message(
        notification=messaging.Notification('Price drop', '2% off all books'),
        topic='readers-club',
    ),
]

response = messaging.send_all(messages)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))
cloud_messaging.py

برو

// Create a list containing up to 500 messages.
messages := []*messaging.Message{
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "5% off all electronics",
		},
		Token: registrationToken,
	},
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "2% off all books",
		},
		Topic: "readers-club",
	},
}

br, err := client.SendAll(context.Background(), messages)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)
messaging.go

سی شارپ

// Create a list containing up to 500 messages.
var messages = new List<Message>()
{
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "5% off all electronics",
        },
        Token = registrationToken,
    },
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "2% off all books",
        },
        Topic = "readers-club",
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachAsync(messages);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");
FirebaseMessagingSnippets.cs

ارسال پیام های با قابلیت بوت مستقیم (فقط Android)

می توانید با استفاده از API های HTTP V1 یا Legacy HTTP ، به دستگاه ها در حالت بوت مستقیم ارسال کنید. قبل از ارسال به دستگاه ها در حالت بوت مستقیم ، حتماً مراحل لازم را برای فعال کردن دستگاه های مشتری برای دریافت پیام های FCM در حالت بوت مستقیم انجام داده اید.

احتیاط: مهم است که دید پیام های مستقیم با بوت را در نظر بگیرید. هر کاربر با دسترسی به دستگاه می تواند بدون وارد کردن اعتبار کاربر ، این پیام ها را مشاهده کند.

با استفاده از API FCM V1 HTTP ارسال کنید

درخواست پیام باید شامل کلید "direct_boot_ok" : true در گزینه های AndroidConfig بدنه درخواست صحیح است. به عنوان مثال:

https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
  "message":{
    "token" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
    "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "android": {
      "direct_boot_ok": true,
    },
}

پیام ها را در سیستم عامل ها سفارشی کنید

Firebase Admin SDK و پروتکل FCM V1 HTTP هر دو به درخواست پیام شما اجازه می دهند تا تمام قسمت های موجود در شیء message را تنظیم کنند. این شامل:

• مجموعه ای از زمینه های مشترک که توسط همه موارد برنامه ای که پیام را دریافت می کنند ، تفسیر می شوند.
• مجموعه های خاص پلتفرم از زمینه ها ، مانند AndroidConfig و WebpushConfig ، که فقط توسط نمونه های برنامه در حال اجرا بر روی پلت فرم مشخص شده تفسیر می شوند.

بلوک های خاص پلتفرم به شما انعطاف پذیری می دهد تا پیام ها را برای سیستم عامل های مختلف شخصی سازی کنید تا اطمینان حاصل شود که در هنگام دریافت به درستی از آنها برخورد می شوند. BACEND FCM تمام پارامترهای مشخص شده را در نظر می گیرد و پیام را برای هر سیستم عامل سفارشی می کند.

چه زمانی از زمینه های مشترک استفاده کنید

در صورتی که از زمینه های مشترک استفاده کنید:

• هدف قرار دادن نمونه های برنامه در همه سیستم عامل ها - اپل ، اندروید و وب
• ارسال پیام به موضوعات

همه نمونه های برنامه ، صرف نظر از پلتفرم ، می توانند زمینه های مشترک زیر را تفسیر کنند:

• message.notification.title
• message.notification.body
• message.data

چه زمانی از زمینه های خاص پلت فرم استفاده کنید

وقتی می خواهید از فیلدهای خاص پلتفرم استفاده کنید:

• ارسال قسمت ها فقط به سیستم عامل های خاص
• علاوه بر زمینه های مشترک ، زمینه های خاص سیستم عامل را ارسال کنید

هر زمان که می خواهید فقط به سیستم عامل های خاص مقادیر ارسال کنید ، از زمینه های مشترک استفاده نکنید . از زمینه های خاص پلتفرم استفاده کنید. به عنوان مثال ، برای ارسال یک اعلان فقط به سیستم عامل های اپل و وب اما نه به Android ، باید از دو مجموعه جداگانه از فیلد ، یکی برای اپل و دیگری برای وب استفاده کنید.

هنگامی که در حال ارسال پیام با گزینه های تحویل خاص هستید ، برای تنظیم آنها از قسمت های خاص پلتفرم استفاده کنید. در صورت تمایل می توانید مقادیر مختلفی را برای هر پلتفرم مشخص کنید. با این حال ، حتی وقتی می خواهید اساساً همان مقدار را در سیستم عامل ها تنظیم کنید ، باید از فیلدهای خاص پلتفرم استفاده کنید. این امر به این دلیل است که هر پلتفرم ممکن است مقدار کمی متفاوت را تفسیر کند-برای مثال ، زمان به زندگی در اندروید به عنوان زمان انقضا در ثانیه تنظیم می شود ، در حالی که در اپل به عنوان تاریخ انقضا تعیین شده است.

مثال: پیام اعلان با گزینه های رنگ و نماد

این مثال درخواست ارسال یک عنوان و محتوای مشترک را به همه سیستم عامل ها ارسال می کند ، اما همچنین برخی از موارد اضافی پلتفرم را به دستگاه های Android ارسال می کند.

برای Android ، این درخواست یک نماد و رنگ ویژه را برای نمایش در دستگاه های Android تنظیم می کند. همانطور که در مرجع AndroidNotification ذکر شد ، رنگ در قالب #RRGGBB مشخص شده است ، و تصویر باید یک منبع قابل ترسیم باشد که به برنامه Android محلی باشد.

در اینجا تقریب اثر بصری بر روی دستگاه کاربر وجود دارد:

Node.js

const topicName = 'industry-tech';

const message = {
  notification: {
    title: '`$FooCorp` up 1.43% on the day',
    body: 'FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  android: {
    notification: {
      icon: 'stock_ticker_update',
      color: '#7e55c3'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

جاوا

Message message = Message.builder()
    .setNotification(Notification.builder()
        .setTitle("$GOOG up 1.43% on the day")
        .setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
        .build())
    .setAndroidConfig(AndroidConfig.builder()
        .setTtl(3600 * 1000)
        .setNotification(AndroidNotification.builder()
            .setIcon("stock_ticker_update")
            .setColor("#f45342")
            .build())
        .build())
    .setApnsConfig(ApnsConfig.builder()
        .setAps(Aps.builder()
            .setBadge(42)
            .build())
        .build())
    .setTopic("industry-tech")
    .build();
FirebaseMessagingSnippets.java

پایتون

message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    android=messaging.AndroidConfig(
        ttl=datetime.timedelta(seconds=3600),
        priority='normal',
        notification=messaging.AndroidNotification(
            icon='stock_ticker_update',
            color='#f45342'
        ),
    ),
    apns=messaging.APNSConfig(
        payload=messaging.APNSPayload(
            aps=messaging.Aps(badge=42),
        ),
    ),
    topic='industry-tech',
)
cloud_messaging.py

برو

oneHour := time.Duration(1) * time.Hour
badge := 42
message := &messaging.Message{
	Notification: &messaging.Notification{
		Title: "$GOOG up 1.43% on the day",
		Body:  "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
	},
	Android: &messaging.AndroidConfig{
		TTL: &oneHour,
		Notification: &messaging.AndroidNotification{
			Icon:  "stock_ticker_update",
			Color: "#f45342",
		},
	},
	APNS: &messaging.APNSConfig{
		Payload: &messaging.APNSPayload{
			Aps: &messaging.Aps{
				Badge: &badge,
			},
		},
	},
	Topic: "industry-tech",
}
messaging.go

سی شارپ

var message = new Message
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Android = new AndroidConfig()
    {
        TimeToLive = TimeSpan.FromHours(1),
        Notification = new AndroidNotification()
        {
            Icon = "stock_ticker_update",
            Color = "#f45342",
        },
    },
    Apns = new ApnsConfig()
    {
        Aps = new Aps()
        {
            Badge = 42,
        },
    },
    Topic = "industry-tech",
};
FirebaseMessagingSnippets.cs

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"`$FooCorp` up 1.43% on the day",
       "body":"FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day."
     },
     "android":{
       "notification":{
         "icon":"stock_ticker_update",
         "color":"#7e55c3"
       }
     }
   }
 }

برای جزئیات کامل در کلیدهای موجود در بلوک های خاص پلت فرم در بدنه پیام ، به اسناد مرجع HTTP V1 مراجعه کنید.

مثال: پیام اعلان با یک تصویر سفارشی

مثال زیر درخواست ارسال یک عنوان اعلان مشترک را به همه سیستم عامل ها ارسال می کند ، اما همچنین تصویری را ارسال می کند. در اینجا تقریب اثر بصری بر روی دستگاه کاربر وجود دارد:

Node.js

const topicName = 'industry-tech';

const message = {
  notification: {
    title: 'Sparky says hello!'
  },
  android: {
    notification: {
      imageUrl: 'https://foo.bar.pizza-monster.png'
    }
  },
  apns: {
    payload: {
      aps: {
        'mutable-content': 1
      }
    },
    fcm_options: {
      image: 'https://foo.bar.pizza-monster.png'
    }
  },
  webpush: {
    headers: {
      image: 'https://foo.bar.pizza-monster.png'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"Sparky says hello!",
     },
     "android":{
       "notification":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "mutable-content":1
         }
       },
       "fcm_options": {
           "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "webpush":{
       "headers":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     }
   }
 }

برای جزئیات کامل در کلیدهای موجود در بلوک های خاص پلت فرم در بدنه پیام ، به اسناد مرجع HTTP V1 مراجعه کنید.

مثال: پیام اعلان با یک عمل کلیک همراه

مثال زیر درخواست ارسال یک عنوان اعلان مشترک را به همه سیستم عامل ها ارسال می کند ، اما همچنین اقدامی را برای برنامه در پاسخ به تعامل کاربر با اعلان انجام می دهد. در اینجا تقریب اثر بصری بر روی دستگاه کاربر وجود دارد:

Node.js

const topicName = 'industry-tech';

const message = {
  notification: {
    title: 'Breaking News....'
  },
  android: {
    notification: {
      clickAction: 'news_intent'
    }
  },
  apns: {
    payload: {
      aps: {
        'category': 'INVITE_CATEGORY'
      }
    }
  },
  webpush: {
    fcmOptions: {
      link: 'breakingnews.html'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"Breaking News...",
     },
     "android":{
       "notification":{
         "click_action":"news_intent"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "category" : "INVITE_CATEGORY"
         }
       },
     },
     "webpush":{
       "fcm_options":{
         "link":"breakingnews.html"
       }
     }
   }
 }

برای جزئیات کامل در کلیدهای موجود در بلوک های خاص پلت فرم در بدنه پیام ، به اسناد مرجع HTTP V1 مراجعه کنید.

مثال: پیام اعلان با گزینه های محلی سازی

مثال زیر درخواست ارسال گزینه های محلی سازی را برای مشتری برای نمایش پیام های بومی شده ارسال می کند. در اینجا تقریب اثر بصری بر روی دستگاه کاربر وجود دارد:

Node.js

var topicName = 'industry-tech';

var message = {
  android: {
    ttl: 3600000,
    notification: {
      bodyLocKey: 'STOCK_NOTIFICATION_BODY',
      bodyLocArgs: ['FooCorp', '11.80', '835.67', '1.43']
    }
  },
  apns: {
    payload: {
      aps: {
        alert: {
          locKey: 'STOCK_NOTIFICATION_BODY',
          locArgs: ['FooCorp', '11.80', '835.67', '1.43']
        }
      }
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

استراحت

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
             "topic":"Tech",
             "android":{
               "ttl":"3600s",
               "notification":{
                 "body_loc_key": "STOCK_NOTIFICATION_BODY",
                 "body_loc_args":  ["FooCorp", "11.80", "835.67", "1.43"],
               },
             },
             "apns":{
               "payload":{
                 "aps":{
                   "alert" : {
                     "loc-key": "STOCK_NOTIFICATION_BODY",
                     "loc-args":  ["FooCorp", "11.80", "835.67", "1.43"],
                    },
                 },
               },
             },
  },
}'

برای جزئیات کامل در کلیدهای موجود در بلوک های خاص پلت فرم در بدنه پیام ، به اسناد مرجع HTTP V1 مراجعه کنید.

کدهای خطای استراحت برای API HTTP V1

پاسخ خطای HTTP برای HTTP V1 API حاوی کد خطا ، پیام خطا و وضعیت خطا است. آنها همچنین ممکن است دارای یک آرایه details با جزئیات بیشتر در مورد خطا باشند.

در اینجا دو پاسخ خطای نمونه آورده شده است:

مثال 1: پاسخ خطا از درخواست API HTTP V1 با یک مقدار نامعتبر در یک پیام داده

{
  "error": {
    "code": 400,
    "message": "Invalid value at 'message.data[0].value' (TYPE_STRING), 12",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.BadRequest",
        "fieldViolations": [
          {
            "field": "message.data[0].value",
            "description": "Invalid value at 'message.data[0].value' (TYPE_STRING), 12"
          }
        ]
      }
    ]
  }
}

مثال 2: پاسخ خطا از درخواست API HTTP V1 با یک نشانه ثبت نام نامعتبر

{
  "error": {
    "code": 400,
    "message": "The registration token is not a valid FCM registration token",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.firebase.fcm.v1.FcmError",
        "errorCode": "INVALID_ARGUMENT"
      }
    ]
   }
}

توجه داشته باشید که هر دو پیام دارای یک کد و وضعیت یکسان هستند ، اما آرایه جزئیات حاوی مقادیر در انواع مختلف است. مثال اول دارای type.googleapis.com/google.rpc.BadRequest است که خطایی را در مقادیر درخواست نشان می دهد. مثال دوم با type.googleapis.com/google.firebase.fcm.v1.FcmError یک خطای خاص FCM دارد. برای بسیاری از خطاها ، آرایه جزئیات حاوی اطلاعاتی است که برای اشکال زدایی و یافتن قطعنامه لازم دارید.

در جدول زیر کدهای خطای API FCM V1 REST و توضیحات آنها ذکر شده است.

کد خطا	توضیحات و مراحل وضوح
UNSPECIFIED_ERROR هیچ اطلاعات بیشتری در مورد این خطا در دسترس نیست.	هیچ کدام.
INVALID_ARGUMENT (کد خطای HTTP = 400) پارامترهای درخواست نامعتبر بودند. پسوند نوع google.rpc.BadRequest برای مشخص کردن اینکه کدام قسمت نامعتبر است ، بازگردانده می شود.	علل بالقوه شامل ثبت نام نامعتبر ، نام بسته نامعتبر ، پیام خیلی بزرگ ، کلید داده نامعتبر ، TTL نامعتبر یا سایر پارامترهای نامعتبر است. ثبت نام نامعتبر : قالب نشانه ثبت نام را که به سرور منتقل می کنید ، بررسی کنید. اطمینان حاصل کنید که با نشانه ثبت نام برنامه مشتری از ثبت نام در FCM مطابقت دارد. نشانه را کوتاه نکنید و شخصیت های اضافی اضافه کنید. نام بسته نامعتبر : اطمینان حاصل کنید که پیام به یک نشانه ثبت نام که نام بسته آن با مقدار منتقل شده در درخواست مطابقت دارد ، ارسال شده است. پیام خیلی بزرگ : بررسی کنید که اندازه کل داده های بار موجود در یک پیام از محدودیت های FCM تجاوز نمی کند: 4096 بایت برای بیشتر پیام ها ، یا 2048 بایت در مورد پیام به موضوعات. این شامل کلیدها و مقادیر است. کلید داده های نامعتبر : بررسی کنید که داده های بارگذاری حاوی یک کلید (مانند ، یا GCM یا هر مقدار پیشوند شده توسط Google) نیست که توسط FCM در داخل استفاده می شود. توجه داشته باشید که برخی از کلمات (مانند Collapse_Key) نیز توسط FCM استفاده می شوند اما در بار بار مجاز هستند ، در این صورت مقدار بار بار توسط مقدار FCM نادیده گرفته می شود. نامعتبر TTL : بررسی کنید که مقدار مورد استفاده در TTL یک عدد صحیح است که مدت زمان در ثانیه بین 0 تا 419،200 (4 هفته) را نشان می دهد. پارامترهای نامعتبر : بررسی کنید که پارامترهای ارائه شده دارای نام و نوع مناسب هستند.
نمونه برنامه UNREGISTERED (کد خطای HTTP = 404) از FCM ثبت نشده است. این معمولاً بدان معنی است که نشانه مورد استفاده دیگر معتبر نیست و باید مورد استفاده جدید باشد.	این خطا می تواند در اثر نشانه های ثبت نام از دست رفته یا نشانه های ثبت نشده ایجاد شود. ثبت نام از دست رفته : اگر هدف پیام یک مقدار token است ، بررسی کنید که درخواست حاوی نشانه ثبت است. ثبت نشده است : یک نشانه ثبت نام موجود ممکن است در تعدادی از سناریوها معتبر باشد ، از جمله: - اگر برنامه مشتری با FCM ثبت نام کند. - اگر برنامه مشتری به طور خودکار ثبت نشده باشد ، اگر کاربر برنامه را حذف کند ، می تواند اتفاق بیفتد. به عنوان مثال ، در iOS ، اگر سرویس بازخورد APNS نشانه APNS را نامعتبر کند. - اگر نشانه ثبت نام منقضی شود (به عنوان مثال ، Google ممکن است تصمیم بگیرد که نشانه های ثبت نام را تازه کند ، یا APNS Token برای دستگاه های iOS منقضی شده است). - در صورت بروزرسانی برنامه مشتری اما نسخه جدید برای دریافت پیام پیکربندی نشده است. برای همه این موارد ، این نشانه ثبت نام را از سرور برنامه حذف کرده و استفاده از آن را برای ارسال پیام متوقف کنید.
SENDER_ID_MISMATCH (کد خطای HTTP = 403) شناسه فرستنده معتبر با شناسه فرستنده برای نشانه ثبت نام متفاوت است.	نشانه ثبت نام به گروه خاصی از فرستنده ها گره خورده است. هنگامی که یک برنامه مشتری برای FCM ثبت نام می کند ، باید مشخص کند که چه ارسال کنندگان مجاز به ارسال پیام هستند. هنگام ارسال پیام به برنامه مشتری باید از یکی از آن شناسه های فرستنده استفاده کنید. اگر به یک فرستنده متفاوت تغییر دهید ، نشانه های ثبت نام موجود کار نمی کنند.
QUOTA_EXCEEDED (کد خطای HTTP = 429) برای هدف پیام بیش از حد بود. پسوند نوع google.rpc.QuotaFailure برای مشخص کردن اینکه از سهمیه فراتر رفته است ، بازگردانده می شود.	این خطا می تواند ناشی از سهمیه نرخ پیام بیش از حد ، بیش از سهمیه نرخ پیام دستگاه یا بیش از سهمیه نرخ پیام موضوع باشد. نرخ پیام بیش از : نرخ ارسال پیام ها خیلی زیاد است. شما باید نرخ کلی ارسال پیام را کاهش دهید. برای امتحان مجدد پیام های رد شده از پشتیبان نمایی با حداقل تأخیر اولیه 1 دقیقه استفاده کنید. نرخ پیام دستگاه بیش از : میزان پیام ها به یک دستگاه خاص بسیار زیاد است. محدودیت نرخ پیام را به یک دستگاه واحد مشاهده کنید . تعداد پیام های ارسال شده به این دستگاه را کاهش داده و برای ارسال مجدد از Backoff Exponential استفاده کنید. نرخ پیام موضوع بیش از : نرخ پیام برای مشترکین به یک موضوع خاص بسیار زیاد است. تعداد پیام های ارسال شده برای این موضوع را کاهش داده و از برگه نمایی با حداقل تأخیر اولیه 1 دقیقه برای تلاش مجدد استفاده کنید.
UNAVAILABLE (کد خطای HTTP = 503) سرور بیش از حد بارگیری می شود.	سرور نمی تواند درخواست را به موقع پردازش کند. همان درخواست را دوباره امتحان کنید ، اما باید: - اگر در پاسخ از سرور اتصال FCM گنجانده شده است ، از عنوان مجدد پس از آن احترام بگذارید. - اجرای مجدد نمایی در مکانیسم آزمایش مجدد خود را اجرا کنید. (به عنوان مثال اگر یک ثانیه قبل از تلاش اول صبر کردید ، حداقل دو ثانیه قبل از مرحله بعدی صبر کنید ، سپس 4 ثانیه و غیره). اگر چندین پیام ارسال می کنید ، استفاده از لرزش را در نظر بگیرید. برای اطلاعات بیشتر ، به بازآزمایی های دست زدن مراجعه کنید . فرستنده هایی که باعث ایجاد مشکل می شوند در معرض خطر قرار می گیرند.
INTERNAL (کد خطای HTTP = 500) یک خطای داخلی ناشناخته رخ داده است.	سرور هنگام تلاش برای پردازش درخواست با خطایی روبرو شد. شما می توانید همان درخواست را به دنبال پیشنهادات در انجام تدابیر مجدد دوباره امتحان کنید . اگر خطا ادامه دارد ، لطفاً با پشتیبانی Firebase تماس بگیرید.
THIRD_PARTY_AUTH_ERROR (کد خطای http = 401) گواهی APNS یا کلید AUTH PUSH AUT نامعتبر یا مفقود بود.	پیامی که به یک دستگاه iOS یا ثبت نام فشار وب هدف داده می شود قابل ارسال نیست. اعتبار اعتبارنامه های توسعه و تولید خود را بررسی کنید.

کدهای خطای سرپرست

در جدول زیر کدهای خطای API FCM Admin Firebase Admin و توضیحات آنها ، از جمله مراحل وضوح توصیه شده ذکر شده است.

کد خطا	توضیحات و مراحل وضوح
messaging/invalid-argument	یک استدلال نامعتبر به یک روش FCM ارائه شد. پیام خطا باید حاوی اطلاعات اضافی باشد.
messaging/invalid-recipient	گیرنده پیام در نظر گرفته شده نامعتبر است. پیام خطا باید حاوی اطلاعات اضافی باشد.
messaging/invalid-payload	یک شیء بارگذاری پیام نامعتبر ارائه شد. پیام خطا باید حاوی اطلاعات اضافی باشد.
messaging/invalid-data-payload-key	بارگیری پیام داده شامل یک کلید نامعتبر است. برای کلیدهای محدود به مستندات مرجع DataMessagePayload مراجعه کنید.
messaging/payload-size-limit-exceeded	بار پیام ارائه شده بیش از حد اندازه FCM است. حد برای اکثر پیام ها 4096 بایت است. برای پیام های ارسال شده به موضوعات ، حد 2048 بایت است. اندازه بار بارگذاری شامل کلیدها و مقادیر است.
messaging/invalid-options	یک شیء گزینه های پیام نامعتبر ارائه شد. پیام خطا باید حاوی اطلاعات اضافی باشد.
messaging/invalid-registration-token	نشانه ثبت نام نامعتبر ارائه شده است. اطمینان حاصل کنید که با نشانه ثبت نام برنامه مشتری از ثبت نام در FCM مطابقت دارد. شخصیت های اضافی را کوتاه نکنید یا به آن اضافه کنید.
messaging/registration-token-not-registered	نشانه ثبت ارائه شده ثبت نشده است. یک نشانه ثبت نام قبلاً معتبر می تواند به دلایل مختلفی از جمله: برنامه مشتری خود را از FCM ثبت نکرد. برنامه مشتری به طور خودکار ثبت نشده بود. اگر کاربر برنامه را حذف کند یا در سیستم عامل های اپل ، اگر سرویس بازخورد APNS نشانه APNS را نامعتبر کند ، می تواند این اتفاق بیفتد. نشانه ثبت نام منقضی شد. به عنوان مثال ، Google ممکن است تصمیم بگیرد که نشانه های ثبت نام را تازه کند یا نشانه APNS ممکن است برای دستگاه های اپل منقضی شده باشد. برنامه مشتری به روز شد ، اما نسخه جدید برای دریافت پیام پیکربندی نشده است. برای همه این موارد ، این نشانه ثبت نام را حذف کرده و استفاده از آن را برای ارسال پیام متوقف کنید.
messaging/invalid-package-name	این پیام به یک نشانه ثبت نام خطاب شده است که نام بسته آن با گزینه ارائه شده restrictedPackageName مطابقت ندارد.
messaging/message-rate-exceeded	میزان پیام ها به یک هدف خاص بسیار زیاد است. تعداد پیام های ارسال شده به این دستگاه یا موضوع را کاهش دهید و بلافاصله ارسال مجدد به این هدف را دوباره امتحان نکنید.
messaging/device-message-rate-exceeded	میزان پیام ها به یک دستگاه خاص بسیار زیاد است. تعداد پیام های ارسال شده به این دستگاه را کاهش داده و بلافاصله ارسال مجدد به این دستگاه را دوباره امتحان نکنید.
messaging/topics-message-rate-exceeded	میزان پیام برای مشترکین به یک موضوع خاص بسیار زیاد است. تعداد پیام های ارسال شده برای این موضوع را کاهش دهید و بلافاصله ارسال مجدد به این موضوع را دوباره امتحان نکنید.
messaging/too-many-topics	یک نشانه ثبت نام در حداکثر تعداد موضوعات مشترک شده است و دیگر نمی تواند مشترک شود.
messaging/invalid-apns-credentials	پیامی که برای یک دستگاه اپل هدف قرار گرفته است نمی تواند ارسال شود زیرا گواهی APNS SSL مورد نیاز بارگذاری نشده یا منقضی نشده است. اعتبار گواهینامه های توسعه و تولید خود را بررسی کنید.
messaging/mismatched-credential	اعتبار مورد استفاده برای تأیید اعتبار این SDK مجوز ارسال پیام به دستگاه مربوط به نشانه ثبت نام ارائه شده ندارد. اطمینان حاصل کنید که اعتبار و ثبت نام هر دو متعلق به یک پروژه Firebase یکسان است. برای اسناد و مدارک در مورد چگونگی تأیید اعتبار SDK S Firebase Admin SDK S را به برنامه خود اضافه کنید .
messaging/authentication-error	SDK نتوانست به سرورهای FCM تأیید شود. اطمینان حاصل کنید که Firebase Admin SDK با اعتبارنامه که دارای مجوزهای مناسب برای ارسال پیام های FCM است ، تأیید کرده اید. برای اسناد و مدارک در مورد چگونگی تأیید اعتبار SDK S Firebase Admin SDK S را به برنامه خود اضافه کنید .
messaging/server-unavailable	سرور FCM نمی تواند درخواست را به موقع پردازش کند. شما باید همان درخواست را امتحان کنید ، اما باید: اگر در پاسخ از سرور اتصال FCM گنجانده شده است ، از عنوان Retry-After استفاده کنید. در مکانیسم آزمایش مجدد خود ، برگشتی نمایی را اجرا کنید. به عنوان مثال ، اگر یک ثانیه قبل از تلاش اول صبر کردید ، حداقل دو ثانیه قبل از مرحله بعدی صبر کنید ، سپس چهار ثانیه و غیره. اگر در حال ارسال پیام های متعدد هستید ، هرکدام را به طور مستقل با یک مقدار تصادفی اضافی به تأخیر بیندازید تا از صدور درخواست جدید برای همه پیام ها به طور همزمان خودداری کنید. فرستنده هایی که باعث ایجاد مشکلاتی در لیست سیاه می شوند.
messaging/internal-error	سرور FCM هنگام تلاش برای پردازش درخواست با خطایی روبرو شد. شما می توانید همان درخواست را به دنبال الزامات ذکر شده در ردیف messaging/server-unavailable در بالا ، دوباره امتحان کنید. اگر این خطا ادامه دارد ، لطفاً مشکل را به کانال پشتیبانی گزارش اشکال ما گزارش دهید.
messaging/unknown-error	خطای سرور ناشناخته برگردانده شد. برای اطلاعات بیشتر به پاسخ سرور خام در پیام خطا مراجعه کنید. اگر این خطا را دریافت کردید ، لطفاً پیام خطای کامل را به کانال پشتیبانی گزارش اشکال ما گزارش دهید.

ارسال پیام با استفاده از پروتکل های سرور برنامه Legacy

احتیاط: ارسال پیام (از جمله پیام های بالادست) با API های FCM XMPP و HTTP میراث در 20 ژوئن 2023 کاهش یافت و از ژوئن 2024 حذف می شود . اگر از API های Send Legacy FCM استفاده می کنید ، ما اکیداً توصیه می کنیم که به API HTTP V1 مهاجرت کنید یا از Admin SDK برای ساخت درخواست ارسال استفاده کنید.

اگر در حال حاضر از پروتکل های میراث استفاده می کنید ، همانطور که در این بخش نشان داده شده است ، درخواست پیام را بسازید. به خاطر داشته باشید که اگر از طریق HTTP به چندین سیستم عامل ارسال می کنید ، پروتکل V1 می تواند درخواست های پیام شما را تا حد زیادی ساده کند.

ارسال پیام به دستگاه های خاص

برای ارسال پیام به دستگاه های خاص ، برای نمونه برنامه خاص ، to را برای نشانه ثبت نام تنظیم کنید. برای کسب اطلاعات بیشتر در مورد نشانه های ثبت نام ، به اطلاعات تنظیم مشتری برای سیستم عامل خود مراجعه کنید.

درخواست ارسال http

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}

پاسخ HTTP

{ "multicast_id": 108,
  "success": 1,
  "failure": 0,
  "results": [
    { "message_id": "1:08" }
  ]
}

پیام XMPP

<message id="">
  <gcm xmlns="google:mobile:data">
    { "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  }
  </gcm>
</message>

پاسخ XMPP

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "from":"REGID",
      "message_id":"m-1366082849205"
      "message_type":"ack"
  }
  </gcm>
</message>

سرور اتصال XMPP گزینه های دیگری را برای پاسخ ها ارائه می دهد. به قالب پاسخ سرور مراجعه کنید.

برای لیست کامل گزینه های پیام موجود هنگام ارسال پیام های پایین دست به برنامه های مشتری ، به اطلاعات مرجع پروتکل سرور اتصال انتخاب شده خود ، HTTP یا XMPP مراجعه کنید.

ارسال پیام به مباحث

ارسال پیام به یک موضوع Firebase Cloud Messaging بسیار شبیه به ارسال پیام به یک دستگاه شخصی یا یک گروه کاربر است. سرور برنامه to را با مقداری مانند /topics/yourTopic تنظیم می کند. توسعه دهندگان می توانند هر نام موضوعی را انتخاب کنند که مطابق با عبارت منظم باشد: "/topics/[a-zA-Z0-9-_.~%]+" .

برای ارسال به ترکیبی از موضوعات متعدد ، سرور برنامه باید کلید condition (به جای کلید to کلید) را در یک شرایط بولی تنظیم کند که موضوعات هدف را مشخص می کند. به عنوان مثال ، ارسال پیام به دستگاه هایی که در TopicA مشترک هستند و یا TopicB یا موضوع یا TopicC :

'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)

FCM ابتدا هر شرایطی را در پرانتز ارزیابی می کند ، و سپس عبارت را از چپ به راست ارزیابی می کند. در عبارت فوق ، کاربر مشترک در هر موضوع واحد پیام را دریافت نمی کند. به همین ترتیب ، کاربر که در TOPICA مشترک نیست ، پیام را دریافت نمی کند. این ترکیبات آن را دریافت می کنند:

• Topica و Topice
• topica و topicc

شما می توانید حداکثر پنج موضوع را در بیان مشروط خود بگنجانید و پرانتز پشتیبانی می شود. اپراتورهای پشتیبانی شده: && ، || .

موضوع HTTP درخواست ارسال

ارسال به یک موضوع واحد:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

ارسال به دستگاه های مشترک در موضوعات "سگ" یا "گربه":

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

موضوع پاسخ http

// Success example:
{
  "message_id": "1023456"
}

// failure example:
{
  "error": "TopicsMessageRateExceeded"
}

موضوع XMPP موضوع

ارسال به یک موضوع واحد:

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

ارسال به دستگاه های مشترک در موضوعات "سگ" یا "گربه":

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

موضوع پاسخ XMPP

// Success example:
{
  "message_id": "1023456"
}

// failure example:
{
  "error": "TopicsMessageRateExceeded"
}

قبل از بازگشت سرور FCM موفقیت یا پاسخ عدم موفقیت به موضوع ارسال درخواست ، تا 30 ثانیه تأخیر انتظار دارید. حتماً مقدار زمان بندی سرور برنامه را در درخواست تنظیم کنید.

توجه: همچنین می توان با تنظیم کلید condition ، پیام ها را به موضوعات مختلف هدف قرار داد. برای اطلاعات بیشتر ، به راهنمای پیام رسانی موضوع برای سیستم عامل خود مراجعه کنید.

ارسال پیام به گروه های دستگاه

احتیاط: ارسال پیام (از جمله پیام های بالادست) با API های FCM XMPP و HTTP میراث در 20 ژوئن 2023 کاهش یافت و از ژوئن 2024 حذف می شود . اگر از API های Send Legacy FCM استفاده می کنید ، ما اکیداً توصیه می کنیم که به API HTTP V1 مهاجرت کنید یا از Admin SDK برای ساخت درخواست ارسال استفاده کنید.

ارسال پیام به یک گروه دستگاه با استفاده از API میراث مستهجن بسیار شبیه به ارسال پیام به یک دستگاه جداگانه است. پارامتر to را روی کلید اعلان منحصر به فرد برای گروه دستگاه تنظیم کنید. نمونه هایی در این بخش نحوه ارسال پیام های داده به گروه های دستگاه در پروتکل های HTTP و XMPP را نشان می دهد.

درخواست ارسال گروه HTTP گروه

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{
  "to": "aUniqueKey",
  "data": {
    "hello": "This is a Firebase Cloud Messaging Device Group Message!",
   }
}

گروه دستگاه پاسخ HTTP

در اینجا نمونه ای از "موفقیت" آورده شده است - notification_key دارای 2 نشانه ثبت نام در ارتباط با آن است و پیام با موفقیت برای هر دوی آنها ارسال شد:

{
  "success": 2,
  "failure": 0
}

در اینجا نمونه ای از "موفقیت جزئی" آورده شده است - notification_key دارای 3 نشانه ثبت نام در ارتباط با آن است. این پیام با موفقیت فقط به 1 نشانه ثبت نام ارسال شد. پیام پاسخ نشانه های ثبت نام ( registration_ids ) را که نتوانست پیام را دریافت کند ، لیست می کند:

{
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

هنگامی که یک پیام به یک یا چند مورد از نشانه های ثبت نام مرتبط با یک notification_key تحویل داده نمی شود ، سرور برنامه باید با بازگرداندن بین ترمیم ها دوباره امتحان کند.

اگر سرور سعی در ارسال پیام به یک گروه دستگاهی که عضو آن نیست ، پاسخ به صورت زیر ، با 0 موفقیت و 0 خرابی به نظر می رسد:

{
  "success": 0,
  "failure": 0
}

پیام XMPP گروه دستگاه

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "to": "aUniqueKey",
      "message_id": "m-1366082849205" ,
      "data": {
          "hello":"This is a Firebase Cloud Messaging Device Group Message!"
      }
  }
  </gcm>
</message>

گروه دستگاه پاسخ XMPP

هنگامی که پیام به هر یک از دستگاه های گروه با موفقیت ارسال می شود ، سرور اتصال XMPP با ACK پاسخ می دهد. اگر تمام پیام های ارسال شده به همه دستگاه های گروه از بین بروند ، سرور اتصال XMPP با NACK پاسخ می دهد.

در اینجا نمونه ای از "موفقیت" وجود دارد - notification_key دارای 3 نشانه ثبت نام در ارتباط با آن است و پیام با موفقیت برای همه آنها ارسال شد:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success": 3,
  "failure": 0,
  "message_id": "m-1366082849205"
}

در اینجا نمونه ای از "موفقیت جزئی" آورده شده است - notification_key دارای 3 نشانه ثبت نام در ارتباط با آن است. این پیام با موفقیت فقط به 1 نشانه ثبت نام ارسال شد. پیام پاسخ نشانه های ثبت نام را که نتوانستند پیام را دریافت کنند ، لیست می کند:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

هنگامی که FCM Connection Server نتواند به همه دستگاه های گروه تحویل دهد. سرور برنامه پاسخ NACK را دریافت می کند.

برای لیست کامل گزینه های پیام ، به اطلاعات مرجع پروتکل سرور اتصال انتخاب شده ، HTTP یا XMPP خود مراجعه کنید.

Firebase Admin SDK Legacy روش ارسال

احتیاط: API های SDK مدیر Node.JS که در این بخش شرح داده شده است در 21 فوریه 2023 کاهش یافته و عملکرد در فوریه 2024 حذف می شود. به جای sendToDevice() و sendToDeviceGroup() ، از send() استفاده کنید.

Node.js SDK Admin Firebase Admin از روش های ارسال پیام ( FCM ) بر اساس API Legacy FCM سرور پشتیبانی می کند. این روشها آرگومان های مختلفی را در مقایسه با روش send() می پذیرند. شما باید در هر زمان ممکن از روش send() استفاده کنید و فقط هنگام ارسال پیام به دستگاه های شخصی یا گروه های دستگاه ، از روش های شرح داده شده در این صفحه استفاده کنید.

توجه: این API ها فقط در Node.js SDK در دسترس هستند.

ارسال به دستگاه های انفرادی

برای ارسال پیام به آن دستگاه می توانید یک نشانه ثبت نام را به روش sendToDevice() منتقل کنید:

Node.js

// This registration token comes from the client FCM SDKs.
const registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device corresponding to the provided
// registration token.
getMessaging().sendToDevice(registrationToken, payload)
  .then((response) => {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

روش sendToDevice() همچنین می تواند با انتقال مجموعه ای از نشانه های ثبت نام به جای فقط یک نشانه ثبت نام ، یک پیام چند مرحله ای (یعنی پیام به چندین دستگاه) ارسال کند:

Node.js

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...',
  // ...
  'ecupwIfBy1w:APA91bFtuMY7MktgxA3Au_Qx7cKqnf...'
];

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the devices corresponding to the provided
// registration tokens.
getMessaging().sendToDevice(registrationTokens, payload)
  .then((response) => {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

توجه: می توانید در یک درخواست واحد پیام به حداکثر 1000 دستگاه ارسال کنید. اگر یک آرایه با بیش از 1000 نشانه ثبت نام ارائه دهید ، درخواست با خطای messaging/invalid-recipient از بین می رود.

روش sendToDevice() وعده ای را که با یک شیء MessagingDevicesResponse حاوی پاسخ از FCM حل می شود ، برمی گرداند. نوع بازگشت هنگام عبور از یک نشانه ثبت نام یا یک مجموعه از نشانه های ثبت نام ، دارای همان قالب است.

برخی موارد مانند خطای احراز هویت یا محدود کردن نرخ باعث می شود که کلیت پیام در پردازش انجام شود. در این موارد ، قول برگشتی توسط sendToDevice() با یک خطا رد می شود. برای لیست کاملی از کدهای خطا ، از جمله توضیحات و مراحل وضوح ، به خطاهای API Admin FCM مراجعه کنید.

ارسال به گروه دستگاه

روش sendToDeviceGroup() به شما امکان می دهد با مشخص کردن کلید اعلان برای آن گروه دستگاه ، پیام را به گروه دستگاه ارسال کنید:

Node.js

// See the "Managing device groups" link above on how to generate a
// notification key.
const notificationKey = 'some-notification-key';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device group corresponding to the provided
// notification key.
getMessaging().sendToDeviceGroup(notificationKey, payload)
  .then((response) => {
    // See the MessagingDeviceGroupResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

روش sendToDeviceGroup() وعده ای را که با یک پیام MessagingDevicesResponse حاوی پاسخ از FCM حل می شود ، برمی گرداند.

برخی موارد مانند خطای احراز هویت یا محدود کردن نرخ باعث می شود که کلیت پیام در پردازش انجام شود. در این موارد ، قول برگشتی توسط sendToDeviceGroup() با یک خطا رد می شود. برای لیست کاملی از کدهای خطا ، از جمله توضیحات و مراحل وضوح ، به خطاهای API Admin FCM مراجعه کنید.

تعریف بار پیام

روشهای فوق مبتنی بر پروتکل های میراث FCM ، یک بار پیام را به عنوان استدلال دوم خود می پذیرند و از پیام های اعلان و پیام های داده پشتیبانی می کنند. می توانید با ایجاد یک شی با کلیدهای data و / یا notification ، یک یا هر دو نوع پیام را مشخص کنید. به عنوان مثال ، در اینجا نحوه تعریف انواع مختلف بارهای پیام:

پیام اعلان

const payload = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  }
};

پیام داده ها

const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

پیام ترکیبی

const payload = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  data: {
    stock: 'GOOG',
    open: '829.62',
    close: '635.67'
  }
};

بارهای پیام اعلان دارای زیر مجموعه از پیش تعریف شده از خصوصیات معتبر هستند و بسته به اینکه سیستم عامل موبایل مورد نظر شما را هدف قرار می دهید کمی متفاوت است. برای یک لیست کامل به اسناد مرجع برای NotificationMessagePayload مراجعه کنید.

بارهای پیام داده از جفت های ارزش کلیدی سفارشی با چند محدودیت تشکیل شده اند ، از جمله این واقعیت که همه مقادیر باید رشته باشند. برای لیست کامل محدودیت ها ، به اسناد مرجع برای DataMessagePayload مراجعه کنید.

تعریف گزینه های پیام

روشهای فوق بر اساس پروتکل های میراث FCM یک آرگومان سوم اختیاری را می پذیرند که برخی از گزینه ها را برای پیام مشخص می کند. به عنوان مثال ، مثال زیر پیام اولویت بالایی را به دستگاهی ارسال می کند که پس از 24 ساعت منقضی می شود:

Node.js

// This registration token comes from the client FCM SDKs.
const registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section above for details
// on how to define a message payload.
const payload = {
  notification: {
    title: 'Urgent action needed!',
    body: 'Urgent action is needed to prevent your account from being disabled!'
  }
};

// Set the message as high priority and have it expire after 24 hours.
const options = {
  priority: 'high',
  timeToLive: 60 * 60 * 24
};

// Send a message to the device corresponding to the provided
// registration token with the provided options.
getMessaging().sendToDevice(registrationToken, payload, options)
  .then((response) => {
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

برای لیست کامل گزینه های موجود ، به اسناد مرجع برای MessagingOptions مراجعه کنید.